Skip to main content

Request

Struct Request 

Source
pub struct Request<T, C = ()> {
    pub body: T,
    pub ctx: C,
    pub headers: HeaderMap,
    pub method: Method,
    pub path: String,
    pub path_params: HashMap<String, String>,
    pub query_params: HashMap<String, String>,
    pub request_id: String,
}
Expand description

HTTP request wrapper providing context alongside the deserialized body

The generic parameter T is the request body type (flatbed-generated struct). The optional parameter C is the application context type (defaults to ()).

§Example

ⓘ
// Simple handler without context
#[route("/ping")]
async fn handle_ping(req: Request<PingRequest>) -> Result<Response<PingResponse>, FlatbedError> {
    Ok(Response::ok(PingResponse { message: Some("pong".into()), ... }))
}

// Handler with application context
#[route("/users")]
async fn handle_users(req: Request<UserRequest, AppCtx>) -> Result<Response<UserResponse>, FlatbedError> {
    let user = req.ctx.db.find_user(&req.body.id).await?;
    Ok(Response::ok(UserResponse { name: user.name, ... }))
}

Fields§

§body: T

The deserialized request body

§ctx: C

Application context (zero-sized when C = ())

§headers: HeaderMap

HTTP headers from the request

§method: Method

HTTP method

§path: String

Request path

§path_params: HashMap<String, String>

Path parameters (e.g., /users/{id} -> {“id”: “123”})

§query_params: HashMap<String, String>

Query string parameters

§request_id: String

Request ID (propagated or generated)

Implementations§

Source§

impl<T, C> Request<T, C>

Source

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

Get a header value by name (case-insensitive)

Source

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

Get a path parameter by name

Source

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

Get a query parameter by name

Source

pub fn request_id(&self) -> &str

Get the request ID

Trait Implementations§

Source§

impl<T: Debug, C: Debug> Debug for Request<T, C>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<T, C> Deref for Request<T, C>

Source§

type Target = T

The resulting type after dereferencing.
Source§

fn deref(&self) -> &T

Dereferences the value.

Auto Trait Implementations§

§

impl<T, C> Freeze for Request<T, C>
where T: Freeze, C: Freeze,

§

impl<T, C> RefUnwindSafe for Request<T, C>

§

impl<T, C> Send for Request<T, C>
where T: Send, C: Send,

§

impl<T, C> Sync for Request<T, C>
where T: Sync, C: Sync,

§

impl<T, C> Unpin for Request<T, C>
where T: Unpin, C: Unpin,

§

impl<T, C> UnsafeUnpin for Request<T, C>
where T: UnsafeUnpin, C: UnsafeUnpin,

§

impl<T, C> UnwindSafe for Request<T, C>
where T: UnwindSafe, C: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more