Struct poem_openapi::param::Header
source · [−]pub struct Header<T>(pub T);Expand description
Represents the parameters passed by the request header.
Tuple Fields
0: TTrait Implementations
sourceimpl<'a, T: ParseFromParameter> ApiExtractor<'a> for Header<T>
impl<'a, T: ParseFromParameter> ApiExtractor<'a> for Header<T>
sourceconst TYPE: ApiExtractorType
const TYPE: ApiExtractorType
The type of API extractor.
sourceconst PARAM_IS_REQUIRED: bool
const PARAM_IS_REQUIRED: bool
If it is true, it means that this parameter is required.
type ParamType = T
type ParamType = T
The parameter type.
type ParamRawType = T::RawValueType
type ParamRawType = T::RawValueType
The raw parameter type for validators.
sourcefn param_in() -> Option<MetaParamIn>
fn param_in() -> Option<MetaParamIn>
Returns the location of the parameter if this extractor is parameter.
sourcefn param_schema_ref() -> Option<MetaSchemaRef>
fn param_schema_ref() -> Option<MetaSchemaRef>
Returns the schema of the parameter if this extractor is parameter.
sourcefn 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.
sourcefn 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
'a: 'async_trait,
'life0: 'async_trait,
Self: '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
'a: 'async_trait,
'life0: 'async_trait,
Self: 'async_trait,
Parse from the HTTP request.
sourcefn security_scheme() -> Option<&'static str>
fn security_scheme() -> Option<&'static str>
Returns name of security scheme if this extractor is security scheme.
sourcefn request_meta() -> Option<MetaRequest>
fn request_meta() -> Option<MetaRequest>
Returns MetaRequest if this extractor is request object.
Auto Trait Implementations
impl<T> RefUnwindSafe for Header<T> where
T: RefUnwindSafe,
impl<T> Send for Header<T> where
T: Send,
impl<T> Sync for Header<T> where
T: Sync,
impl<T> Unpin for Header<T> where
T: Unpin,
impl<T> UnwindSafe for Header<T> where
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber to this type, returning a
WithDispatch wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber to this type, returning a
WithDispatch wrapper. Read more