Trait ApiExtractor 

pub trait ApiExtractor<'a>: Sized {
    type ParamType;
    type ParamRawType;

    const TYPES: &'static [ApiExtractorType];
    const PARAM_IS_REQUIRED: bool = false;

    // Required method
    fn from_request(
        request: &'a Request,
        body: &mut RequestBody,
        param_opts: ExtractParamOptions<Self::ParamType>,
    ) -> impl Future<Output = Result<Self>> + Send;

    // Provided methods
    fn register(registry: &mut Registry) { ... }
    fn security_schemes() -> Vec<&'static str> { ... }
    fn has_security_fallback() -> bool { ... }
    fn param_in() -> Option<MetaParamIn> { ... }
    fn param_schema_ref() -> Option<MetaSchemaRef> { ... }
    fn request_meta() -> Option<MetaRequest> { ... }
    fn param_raw_type(&self) -> Option<&Self::ParamRawType> { ... }
}

Represents an OpenAPI extractor.

Provided Implementations

• Path<T: Type>

Extract the parameters in the request path into Path.

• Query<T: Type>

Extract the parameters in the query string into Query.

• Header<T: Type>

Extract the parameters in the request header into Header.

• Cookie<T: Type>

Extract the parameters in the cookie into Cookie.

• CookiePrivate<T: Type>

Extract the parameters in the private cookie into CookiePrivate.

• CookieSigned<T: Type>

Extract the parameters in the signed cookie into CookieSigned.

• Binary<T>

Extract the request body as binary into Binary.

• Json<T>

Parse the request body in JSON format into Json.

• PlainText<T>

Extract the request body as utf8 string into PlainText.

• Any type derived from the ApiRequest macro

Extract the complex request body derived from the ApiRequest macro.

• Any type derived from the Multipart macro

Extract the multipart object derived from the Multipart macro.

• Any type derived from the SecurityScheme macro

Extract the authentication value derived from the SecurityScheme macro.

• T: poem::FromRequest

Use Poem’s extractor.

Required Associated Constants

const TYPES: &'static [ApiExtractorType]

The type of API extractor.

Provided Associated Constants

const PARAM_IS_REQUIRED: bool = false

If it is true, it means that this parameter is required.

Required Associated Types

type ParamType

The parameter type.

type ParamRawType

The raw parameter type for validators.

Required Methods

fn from_request( request: &'a Request, body: &mut RequestBody, param_opts: ExtractParamOptions<Self::ParamType>, ) -> impl Future<Output = Result<Self>> + Send

Parse from the HTTP request.

Provided Methods

fn register(registry: &mut Registry)

Register related types to registry.

fn security_schemes() -> Vec<&'static str>

Returns names of security scheme if this extractor is security scheme.

fn has_security_fallback() -> bool

Returns true if the extractor is a security scheme with a fallback.

fn param_in() -> Option<MetaParamIn>

Returns the location of the parameter if this extractor is parameter.

fn param_schema_ref() -> Option<MetaSchemaRef>

Returns the schema of the parameter if this extractor is parameter.

fn request_meta() -> Option<MetaRequest>

Returns MetaRequest if this extractor is request object.

fn param_raw_type(&self) -> Option<&Self::ParamRawType>

Returns a reference to the raw type of this parameter.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl<'a, T: DeserializeOwned + Type> ApiExtractor<'a> for Form<T>

const TYPES: &'static [ApiExtractorType]

type ParamType = ()

type ParamRawType = ()

impl<'a, T: FromRequest<'a>> ApiExtractor<'a> for T

const TYPES: &'static [ApiExtractorType]

type ParamType = ()

type ParamRawType = ()

impl<'a, T: ParseFromJSON> ApiExtractor<'a> for Json<T>

const TYPES: &'static [ApiExtractorType]

type ParamType = ()

type ParamRawType = ()

impl<'a, T: ParseFromParameter> ApiExtractor<'a> for Cookie<T>

Available on crate feature cookie only.

const TYPES: &'static [ApiExtractorType]

const PARAM_IS_REQUIRED: bool = T::IS_REQUIRED

type ParamType = T

type ParamRawType = <T as Type>::RawValueType

impl<'a, T: ParseFromParameter> ApiExtractor<'a> for CookiePrivate<T>

Available on crate feature cookie only.

const TYPES: &'static [ApiExtractorType]

const PARAM_IS_REQUIRED: bool = T::IS_REQUIRED

type ParamType = T

type ParamRawType = <T as Type>::RawValueType

impl<'a, T: ParseFromParameter> ApiExtractor<'a> for CookieSigned<T>

Available on crate feature cookie only.

const TYPES: &'static [ApiExtractorType]

const PARAM_IS_REQUIRED: bool = T::IS_REQUIRED

type ParamType = T

type ParamRawType = <T as Type>::RawValueType

impl<'a, T: ParseFromParameter> ApiExtractor<'a> for Header<T>

const TYPES: &'static [ApiExtractorType]

const PARAM_IS_REQUIRED: bool = T::IS_REQUIRED

type ParamType = T

type ParamRawType = <T as Type>::RawValueType

impl<'a, T: ParseFromParameter> ApiExtractor<'a> for Path<T>

const TYPES: &'static [ApiExtractorType]

const PARAM_IS_REQUIRED: bool = T::IS_REQUIRED

type ParamType = T

type ParamRawType = <T as Type>::RawValueType

impl<'a, T: ParseFromParameter> ApiExtractor<'a> for Query<T>

const TYPES: &'static [ApiExtractorType]

const PARAM_IS_REQUIRED: bool = T::IS_REQUIRED

type ParamType = T

type ParamRawType = <T as Type>::RawValueType

impl<'a, T: ParseFromXML> ApiExtractor<'a> for Xml<T>

const TYPES: &'static [ApiExtractorType]

type ParamType = ()

type ParamRawType = ()

impl<'a, T: ParseFromYAML> ApiExtractor<'a> for Yaml<T>

const TYPES: &'static [ApiExtractorType]

type ParamType = ()

type ParamRawType = ()

impl<'a> ApiExtractor<'a> for Base64<Bytes>

const TYPES: &'static [ApiExtractorType]

type ParamType = ()

type ParamRawType = ()

impl<'a> ApiExtractor<'a> for Base64<Vec<u8>>

const TYPES: &'static [ApiExtractorType]

type ParamType = ()

type ParamRawType = ()

impl<'a> ApiExtractor<'a> for Binary<Body>

const TYPES: &'static [ApiExtractorType]

type ParamType = ()

type ParamRawType = ()

impl<'a> ApiExtractor<'a> for Binary<Bytes>

const TYPES: &'static [ApiExtractorType]

type ParamType = ()

type ParamRawType = ()

impl<'a> ApiExtractor<'a> for Binary<Vec<u8>>

const TYPES: &'static [ApiExtractorType]

type ParamType = ()

type ParamRawType = ()

impl<'a> ApiExtractor<'a> for Html<String>

const TYPES: &'static [ApiExtractorType]

type ParamType = ()

type ParamRawType = ()

impl<'a> ApiExtractor<'a> for PlainText<String>

const TYPES: &'static [ApiExtractorType]

type ParamType = ()

type ParamRawType = ()