Struct poem_openapi::payload::PlainText
source · pub struct PlainText<T>(pub T);Expand description
A UTF8 string payload.
Tuple Fields§
§0: TTrait Implementations§
source§impl<'a> ApiExtractor<'a> for PlainText<String>
impl<'a> ApiExtractor<'a> for PlainText<String>
source§const TYPE: ApiExtractorType = crate::ApiExtractorType::RequestObject
const TYPE: ApiExtractorType = crate::ApiExtractorType::RequestObject
The type of API extractor.
§type ParamRawType = ()
type ParamRawType = ()
The raw parameter type for validators.
source§fn request_meta() -> Option<MetaRequest>
fn request_meta() -> Option<MetaRequest>
Returns
MetaRequest if this extractor is request object.source§fn from_request<'life0, 'async_trait>(
request: &'a Request,
body: &'life0 mut RequestBody,
_param_opts: ExtractParamOptions<Self::ParamType>
) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
'life0: 'async_trait,
fn from_request<'life0, 'async_trait>(
request: &'a Request,
body: &'life0 mut RequestBody,
_param_opts: ExtractParamOptions<Self::ParamType>
) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>where
Self: 'async_trait,
'a: 'async_trait,
'life0: 'async_trait,
Parse from the HTTP request.
source§const PARAM_IS_REQUIRED: bool = false
const PARAM_IS_REQUIRED: bool = false
If it is
true, it means that this parameter is required.source§fn security_scheme() -> Option<&'static str>
fn security_scheme() -> Option<&'static str>
Returns name of security scheme if this extractor is security scheme.
source§fn param_in() -> Option<MetaParamIn>
fn param_in() -> Option<MetaParamIn>
Returns the location of the parameter if this extractor is parameter.
source§fn param_schema_ref() -> Option<MetaSchemaRef>
fn param_schema_ref() -> Option<MetaSchemaRef>
Returns the schema of the parameter if this extractor is parameter.
source§fn param_raw_type(&self) -> Option<&Self::ParamRawType>
fn param_raw_type(&self) -> Option<&Self::ParamRawType>
Returns a reference to the raw type of this parameter.
source§impl<T: Into<String> + Send> ApiResponse for PlainText<T>
impl<T: Into<String> + Send> ApiResponse for PlainText<T>
source§fn register(_registry: &mut Registry)
fn register(_registry: &mut Registry)
Register the schema contained in this response object to the registry.
source§const BAD_REQUEST_HANDLER: bool = false
const BAD_REQUEST_HANDLER: bool = false
If true, it means that the response object has a custom bad request
handler.
source§fn from_parse_request_error(err: Error) -> Self
fn from_parse_request_error(err: Error) -> Self
Convert
poem::Error to this response object.source§impl<T: Into<String> + Send> IntoResponse for PlainText<T>
impl<T: Into<String> + Send> IntoResponse for PlainText<T>
source§fn into_response(self) -> Response
fn into_response(self) -> Response
Consume itself and return
Response.source§fn with_header<K, V>(self, key: K, value: V) -> WithHeader<Self>where
K: TryInto<HeaderName>,
V: TryInto<HeaderValue>,
Self: Sized,
fn with_header<K, V>(self, key: K, value: V) -> WithHeader<Self>where
K: TryInto<HeaderName>,
V: TryInto<HeaderValue>,
Self: Sized,
Wrap an
impl IntoResponse to add a header. Read moresource§fn with_content_type<V>(self, content_type: V) -> WithContentType<Self>where
V: TryInto<HeaderValue>,
Self: Sized,
fn with_content_type<V>(self, content_type: V) -> WithContentType<Self>where
V: TryInto<HeaderValue>,
Self: Sized,
Wrap an
impl IntoResponse to with a new content type. Read moresource§fn with_status(self, status: StatusCode) -> WithStatus<Self>where
Self: Sized,
fn with_status(self, status: StatusCode) -> WithStatus<Self>where
Self: Sized,
Wrap an
impl IntoResponse to set a status code. Read moresource§impl ParsePayload for PlainText<String>
impl ParsePayload for PlainText<String>
source§const IS_REQUIRED: bool = true
const IS_REQUIRED: bool = true
If it is
true, it means that this payload is required.source§fn from_request<'life0, 'life1, 'async_trait>(
request: &'life0 Request,
body: &'life1 mut RequestBody
) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn from_request<'life0, 'life1, 'async_trait>(
request: &'life0 Request,
body: &'life1 mut RequestBody
) -> Pin<Box<dyn Future<Output = Result<Self>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Parse the payload object from the HTTP request.
source§impl<T: PartialEq> PartialEq<PlainText<T>> for PlainText<T>
impl<T: PartialEq> PartialEq<PlainText<T>> for PlainText<T>
source§impl<T: Send> Payload for PlainText<T>
impl<T: Send> Payload for PlainText<T>
source§const CONTENT_TYPE: &'static str = "text/plain; charset=utf-8"
const CONTENT_TYPE: &'static str = "text/plain; charset=utf-8"
The content type of this payload.
source§fn check_content_type(content_type: &str) -> bool
fn check_content_type(content_type: &str) -> bool
Check the content type of incoming request
source§fn schema_ref() -> MetaSchemaRef
fn schema_ref() -> MetaSchemaRef
Gets schema reference of this payload.
impl<T: Eq> Eq for PlainText<T>
impl<T> StructuralEq for PlainText<T>
impl<T> StructuralPartialEq for PlainText<T>
Auto Trait Implementations§
impl<T> RefUnwindSafe for PlainText<T>where
T: RefUnwindSafe,
impl<T> Send for PlainText<T>where
T: Send,
impl<T> Sync for PlainText<T>where
T: Sync,
impl<T> Unpin for PlainText<T>where
T: Unpin,
impl<T> UnwindSafe for PlainText<T>where
T: UnwindSafe,
Blanket Implementations§
source§impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
Compare self to
key and return true if they are equal.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoResult<T> for Twhere
T: IntoResponse,
impl<T> IntoResult<T> for Twhere
T: IntoResponse,
source§fn into_result(self) -> Result<T, Error>
fn into_result(self) -> Result<T, Error>
Consumes this value returns a
poem::Result<T>.