Trait edm_core::request::RequestContext

pub trait RequestContext {
    type Method: AsRef<str>;
    type Headers;

    // Required methods
    fn request_method(&self) -> &Self::Method;
    fn original_uri(&self) -> &Uri;
    fn matched_route(&self) -> Cow<'_, str>;
    fn header_map(&self) -> &Self::Headers;
    fn get_header(&self, name: &str) -> Option<&str>;
    fn get_context(&self) -> Option<Context>;
    fn get_data<T: Clone + Send + Sync + 'static>(&self) -> Option<T>;
    fn set_data<T: Clone + Send + Sync + 'static>(
        &mut self,
        value: T
    ) -> Option<T>;
    fn client_ip(&self) -> Option<IpAddr>;
    async fn read_body_bytes(&mut self) -> Result<Bytes, Error>;

    // Provided methods
    fn request_path(&self) -> &str { ... }
    fn new_context(&self) -> Context { ... }
    fn get_trace_context(&self) -> Option<TraceContext> { ... }
    fn new_trace_context(&self) -> TraceContext { ... }
    fn new_cookie(
        &self,
        name: SharedString,
        value: SharedString,
        max_age: Option<Duration>
    ) -> Cookie<'static> { ... }
    fn get_cookie(&self, name: &str) -> Option<Cookie<'_>> { ... }
    fn start_time(&self) -> Instant { ... }
    fn instance(&self) -> String { ... }
    fn request_id(&self) -> Uuid { ... }
    fn trace_id(&self) -> Uuid { ... }
    fn session_id(&self) -> Option<String> { ... }
    fn locale(&self) -> Option<LanguageIdentifier> { ... }
    fn data_type(&self) -> Option<&str> { ... }
    fn get_param(&self, name: &str) -> Option<&str> { ... }
    fn parse_param<T>(&self, name: &str) -> Result<T, Rejection>
       where T: FromStr,
             <T as FromStr>::Err: Error { ... }
    fn get_query(&self, name: &str) -> Option<&str> { ... }
    fn parse_query<T: Default + DeserializeOwned>(&self) -> Result<T, Rejection> { ... }
    async fn parse_body<T: DeserializeOwned>(&mut self) -> Result<T, Rejection> { ... }
    async fn parse_multipart(&mut self) -> Result<Multipart<'_>, Rejection> { ... }
    async fn parse_file(&mut self) -> Result<NamedFile, Rejection> { ... }
    async fn parse_files(&mut self) -> Result<Vec<NamedFile>, Rejection> { ... }
    async fn parse_form_data<T: DeserializeOwned>(
        &mut self
    ) -> Result<(T, Vec<NamedFile>), Rejection> { ... }
    fn parse_authentication(&self) -> Result<Authentication, Rejection> { ... }
    fn parse_access_key_id(&self) -> Result<AccessKeyId, Rejection> { ... }
    fn parse_security_token(
        &self,
        key: &[u8]
    ) -> Result<SecurityToken, Rejection> { ... }
    fn parse_session_id(&self) -> Result<SessionId, Rejection> { ... }
    fn parse_jwt_claims<T, K>(&self, key: &K) -> Result<JwtClaims<T>, Rejection>
       where T: Default + Serialize + DeserializeOwned,
             K: MACLike { ... }
    async fn fetch(
        &self,
        resource: &str,
        options: Option<&Map>
    ) -> Result<Response, Error> { ... }
    async fn fetch_json<T: DeserializeOwned>(
        &self,
        resource: &str,
        options: Option<&Map>
    ) -> Result<T, Error> { ... }
    fn translate(
        &self,
        message: &str,
        args: Option<FluentArgs<'_>>
    ) -> Result<SharedString, Error> { ... }
    fn subscription(&self) -> Subscription { ... }
    fn cloud_event(&self, event_type: String, data: JsonValue) -> CloudEvent { ... }
}

Request context.

Required Associated Types

type Method: AsRef<str>

HTTP request method.

type Headers

A set of HTTP headers.

Required Methods

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

Returns the request method.

fn original_uri(&self) -> &Uri

Returns the original request URI regardless of nesting.

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

Returns the route that matches the request.

fn header_map(&self) -> &Self::Headers

Returns a reference to the request headers.

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

Gets an HTTP header value with the given name.

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.

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

Returns the client’s remote IP.

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

Reads the entire request body into a byte buffer.

Provided Methods

fn request_path(&self) -> &str

Returns the request path regardless of nesting.

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 new_cookie( &self, name: SharedString, value: SharedString, max_age: Option<Duration> ) -> Cookie<'static>

Creates a new cookie with the given name and value.

fn get_cookie(&self, name: &str) -> Option<Cookie<'_>>

Gets a cookie with the given name.

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 locale(&self) -> Option<LanguageIdentifier>

Returns the locale.

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 }.

Note

Please note that it does not handle the percent-decoding. You can use parse_param() if you need percent-decoding.

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

where T: FromStr, <T as FromStr>::Err: 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.

Note

Please note that it does not handle the percent-decoding. You can use parse_query() if you need percent-decoding.

fn parse_query<T: Default + DeserializeOwned>(&self) -> Result<T, Rejection>

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: DeserializeOwned>(&mut self) -> Result<T, Rejection>

Parses the request body as an instance of type T.

Note

Currently, we have built-in support for the following content-type header values:

• application/json
• application/msgpack
• application/problem+json
• application/x-www-form-urlencoded

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: DeserializeOwned>( &mut self ) -> Result<(T, Vec<NamedFile>), Rejection>

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

fn parse_authentication(&self) -> Result<Authentication, Rejection>

Attempts to construct an instance of Authentication from an HTTP request. The value is extracted from the query or the authorization header. By default, the Accept header value is ignored and the canonicalized resource is set to the request path. You should always manually set canonicalized headers by calling Authentication’s method set_headers().

fn parse_access_key_id(&self) -> Result<AccessKeyId, Rejection>

Attempts to construct an instance of AccessKeyId from an HTTP request. The value is extracted from the query parameter access_key_id or the authorization header.

fn parse_security_token(&self, key: &[u8]) -> Result<SecurityToken, Rejection>

Attempts to construct an instance of SecurityToken from an HTTP request. The value is extracted from the x-security-token header.

fn parse_session_id(&self) -> Result<SessionId, Rejection>

Attempts to construct an instance of SessionId from an HTTP request. The value is extracted from the x-session-id or session-id header.

fn parse_jwt_claims<T, K>(&self, key: &K) -> Result<JwtClaims<T>, Rejection>

where T: Default + Serialize + DeserializeOwned, K: MACLike,

Attempts to construct an instance of JwtClaims from an HTTP request. The value is extracted from the query parameter access_token or the authorization header.

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

Makes an HTTP request to the provided resource using reqwest.

async fn fetch_json<T: DeserializeOwned>( &self, resource: &str, options: Option<&Map> ) -> Result<T, Error>

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

fn translate( &self, message: &str, args: Option<FluentArgs<'_>> ) -> Result<SharedString, Error>

Translates the localization message.

fn subscription(&self) -> Subscription

Constructs a new subscription instance.

fn cloud_event(&self, event_type: String, data: JsonValue) -> CloudEvent

Constructs a new cloud event instance.

Object Safety

This trait is not object safe.

Implementors