Struct poem_openapi::param::Cookie
source · [−]pub struct Cookie<T>(pub T);Expand description
Represents the parameters passed by the cookie.
Tuple Fields
0: TTrait Implementations
sourceimpl<'a, T: ParseFromParameter> ApiExtractor<'a> for Cookie<T>
impl<'a, T: ParseFromParameter> ApiExtractor<'a> for Cookie<T>
sourceconst TYPE: ApiExtractorType = ApiExtractorType::Parameter
const TYPE: ApiExtractorType = ApiExtractorType::Parameter
The type of API extractor.
sourceconst PARAM_IS_REQUIRED: bool = T::IS_REQUIRED
const PARAM_IS_REQUIRED: bool = T::IS_REQUIRED
If it is
true, it means that this parameter is required.type ParamType = T
type ParamType = T
The parameter type.
type ParamRawType = <T as Type>::RawValueType
type ParamRawType = <T as Type>::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 Cookie<T>where
T: RefUnwindSafe,
impl<T> Send for Cookie<T>where
T: Send,
impl<T> Sync for Cookie<T>where
T: Sync,
impl<T> Unpin for Cookie<T>where
T: Unpin,
impl<T> UnwindSafe for Cookie<T>where
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
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