Struct Extractor

pub struct Extractor<T>(/* private fields */);

An HTTP request extractor.

Trait Implementations

impl<T> Deref for Extractor<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for Extractor<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl From<Extractor<HttpRequest>> for HttpRequest

fn from(extractor: Extractor<HttpRequest>) -> Self

Converts to this type from the input type.

impl From<HttpRequest> for Extractor<HttpRequest>

fn from(request: HttpRequest) -> Self

Converts to this type from the input type.

impl<Err: ErrorRenderer> From<WebRequest<Err>> for Extractor<HttpRequest>

fn from(request: WebRequest<Err>) -> Self

Converts to this type from the input type.

impl FromRequest<DefaultError> for Extractor<HttpRequest>

type Error = Infallible

The associated error which can be returned.

async fn from_request( req: &HttpRequest, payload: &mut Payload, ) -> Result<Self, Self::Error>

Convert request to a Self

impl RequestContext for Extractor<HttpRequest>

type Method = Method

The method type.

type Uri = Uri

The uri type.

fn request_method(&self) -> &Self::Method

Returns the request method.

fn original_uri(&self) -> &Self::Uri

Returns the original request URI regardless of nesting.

fn matched_route(&self) -> Cow<'_, str>

Returns the route that matches the request.

fn request_path(&self) -> &str

Returns the request path regardless of nesting.

fn get_query_string(&self) -> Option<&str>

Gets the query string of the request.

fn get_header(&self, name: &str) -> Option<&str>

Gets an HTTP header value with the given name.

fn client_ip(&self) -> Option<IpAddr>

Returns the client’s remote IP.

fn get_context(&self) -> Option<Context>

Gets the request context.

fn get_data<T: Clone + Send + Sync + 'static>(&self) -> Option<T>

Gets the request scoped data.

fn set_data<T: Clone + Send + Sync + 'static>(&mut self, value: T) -> Option<T>

Sets the request scoped data and returns the old value if an item of this type was already stored.

async fn read_body_bytes(&mut self) -> Result<Vec<u8>, Error>

Reads the entire request body into a byte buffer.

fn path_segments(&self) -> Vec<&str>

Returns the request path segments.

fn new_context(&self) -> Context

Creates a new request context.

fn get_trace_context(&self) -> Option<TraceContext>

Returns the trace context by parsing the traceparent and tracestate header values.

fn new_trace_context(&self) -> TraceContext

Creates a new TraceContext.

fn start_time(&self) -> Instant

Returns the start time.

fn instance(&self) -> String

Returns the instance.

fn request_id(&self) -> Uuid

Returns the request ID.

fn trace_id(&self) -> Uuid

Returns the trace ID.

fn session_id(&self) -> Option<String>

Returns the session ID.

fn data_type(&self) -> Option<&str>

Gets the data type by parsing the content-type header.

fn get_param(&self, name: &str) -> Option<&str>

Gets the route parameter by name. The name should not include :, *, { or }.

fn decode_param(&self, name: &str) -> Result<Cow<'_, str>, Rejection>

Decodes the UTF-8 percent-encoded route parameter by name.

fn parse_param<T>(&self, name: &str) -> Result<T, Rejection>

where T: FromStr, <T as FromStr>::Err: Into<Error>,

Parses the route parameter by name as an instance of type T. The name should not include :, *, { or }.

fn get_query(&self, name: &str) -> Option<&str>

Gets the query value of the URI by name.

fn decode_query(&self, name: &str) -> Result<Cow<'_, str>, Rejection>

Decodes the UTF-8 percent-encoded query value of the URI by name.

fn parse_query<T>(&self) -> Result<T, Rejection>

where T: Default + DeserializeOwned,

Parses the query as an instance of type T. Returns a default value of T when the query is empty. If the query has a timestamp parameter, it will be used to prevent replay attacks.

async fn parse_body<T>(&mut self) -> Result<T, Rejection>

where T: DeserializeOwned,

Parses the request body as an instance of type T.

async fn parse_multipart(&mut self) -> Result<Multipart<'_>, Rejection>

Parses the request body as a multipart, which is commonly used with file uploads.

async fn parse_file(&mut self) -> Result<NamedFile, Rejection>

Parses the request body as a file.

async fn parse_files(&mut self) -> Result<Vec<NamedFile>, Rejection>

Parses the request body as a list of files.

async fn parse_form_data<T>(&mut self) -> Result<(T, Vec<NamedFile>), Rejection>

where T: DeserializeOwned,

Parses the multipart/form-data as an instance of type T and a list of files.

fn query_validation<S>( &self, query: &mut Query, ) -> Result<Response<S>, Rejection>

where Self: Sized, S: ResponseCode,

Returns a Response or Rejection from a model query validation. The data is extracted from parse_query().

async fn model_validation<M, S>( &mut self, model: &mut M, ) -> Result<Response<S>, Rejection>

where Self: Sized, M: ModelHooks, S: ResponseCode,

Returns a Response or Rejection from a model validation. The data is extracted from parse_body().

async fn fetch( &self, url: &str, options: Option<&Map<String, Value>>, ) -> Result<Response, Error>

Makes an HTTP request to the provided URL.

async fn fetch_json<T>( &self, url: &str, options: Option<&Map<String, Value>>, ) -> Result<T, Error>

where T: DeserializeOwned,

Makes an HTTP request to the provided URL and deserializes the response body via JSON.

fn subscription(&self) -> Subscription

Constructs a new subscription instance.

fn cloud_event(&self, event_type: Cow<'static, str>, data: Value) -> CloudEvent

Constructs a new cloud event instance.

impl<Err: ErrorRenderer> TryFrom<Extractor<HttpRequest>> for WebRequest<Err>

type Error = NtexRejection

The type returned in the event of a conversion error.

fn try_from(extractor: Extractor<HttpRequest>) -> Result<Self, Self::Error>

Performs the conversion.