Struct tide_disco::request::RequestParams

source ·
pub struct RequestParams { /* private fields */ }
Expand description

Parameters passed to a route handler.

These parameters describe the incoming request and the current server state.

Implementations§

source§

impl RequestParams

source

pub fn method(&self) -> Method

The Method used to dispatch the request.

source

pub fn headers(&self) -> &Headers

The headers of the incoming request.

source

pub fn accept(&self) -> Result<Accept, RequestError>

The [Accept] header of this request.

The media type proposals in the resulting header are sorted in order of decreasing weight.

If no [Accept] header was explicitly set, defaults to the wildcard Accept: *.

§Error

Returns RequestError::Http if the [Accept] header is malformed.

source

pub fn remote(&self) -> Option<&str>

Get the remote address for this request.

This is determined in the following priority:

  1. Forwarded header for key
  2. The first X-Forwarded-For header
  3. Peer address of the transport
source

pub fn param<Name>( &self, name: &Name ) -> Result<&RequestParamValue, RequestError>
where Name: ?Sized + Display,

Get the value of a named parameter.

The name of the parameter can be given by any type that implements Display. Of course, the simplest option is to use str or String, as in

req.param("foo")

However, you have the option of defining a statically typed enum representing the possible parameters of a given route and using enum variants as parameter names. Among other benefits, this allows you to change the client-facing parameter names just by tweaking the Display implementation of your enum, without changing other code.

use std::fmt::{self, Display, Formatter};

enum RouteParams {
    Param1,
    Param2,
}

impl Display for RouteParams {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        let name = match self {
            Self::Param1 => "param1",
            Self::Param2 => "param2",
        };
        write!(f, "{}", name)
    }
}

req.param(&RouteParams::Param1)

You can also use [strum_macros] to automatically derive the Display implementation, so you only have to specify the client-facing names of each parameter:

#[derive(strum_macros::Display)]
enum RouteParams {
    #[strum(serialize = "param1")]
    Param1,
    #[strum(serialize = "param2")]
    Param2,
}

req.param(&RouteParams::Param1)
§Errors

Returns RequestError::MissingParam if a parameter called name was not provided with the request.

It is recommended to implement From<RequestError> for the error type for your API, so that you can use ? with this function in a route handler. If your error type implements Error, you can easily use the catch_all constructor to do this:

use serde::{Deserialize, Serialize};
use snafu::Snafu;
use tide_disco::{Error, RequestError, RequestParams, StatusCode};

type ApiState = ();

#[derive(Debug, Snafu, Deserialize, Serialize)]
struct ApiError {
    status: StatusCode,
    msg: String,
}

impl Error for ApiError {
    fn catch_all(status: StatusCode, msg: String) -> Self {
        Self { status, msg }
    }

    fn status(&self) -> StatusCode {
        self.status
    }
}

impl From<RequestError> for ApiError {
    fn from(err: RequestError) -> Self {
        Self::catch_all(StatusCode::BAD_REQUEST, err.to_string())
    }
}

async fn my_route_handler(req: RequestParams, _state: &ApiState) -> Result<(), ApiError> {
    let param = req.param("my_param")?;
    Ok(())
}
source

pub fn opt_param<Name>(&self, name: &Name) -> Option<&RequestParamValue>
where Name: ?Sized + Display,

Get the value of a named optional parameter.

Like param, but returns None instead of Err if the parametre is missing.

source

pub fn integer_param<Name, T>(&self, name: &Name) -> Result<T, RequestError>
where Name: ?Sized + Display, T: TryFrom<u128>,

Get the value of a named parameter and convert it to an integer.

Like param, but returns Err if the parameter value cannot be converted to an integer of the desired size.

source

pub fn opt_integer_param<Name, T>( &self, name: &Name ) -> Result<Option<T>, RequestError>
where Name: ?Sized + Display, T: TryFrom<u128>,

Get the value of a named optional parameter and convert it to an integer.

Like opt_param, but returns Err if the parameter value cannot be converted to an integer of the desired size.

source

pub fn boolean_param<Name>(&self, name: &Name) -> Result<bool, RequestError>
where Name: ?Sized + Display,

Get the value of a named parameter and convert it to a bool.

Like param, but returns Err if the parameter value cannot be converted to a bool.

source

pub fn opt_boolean_param<Name>( &self, name: &Name ) -> Result<Option<bool>, RequestError>
where Name: ?Sized + Display,

Get the value of a named optional parameter and convert it to a bool.

Like opt_param, but returns Err if the parameter value cannot be converted to a bool.

source

pub fn string_param<Name>(&self, name: &Name) -> Result<&str, RequestError>
where Name: ?Sized + Display,

Get the value of a named parameter and convert it to a string.

Like param, but returns Err if the parameter value cannot be converted to a String.

source

pub fn opt_string_param<Name>( &self, name: &Name ) -> Result<Option<&str>, RequestError>
where Name: ?Sized + Display,

Get the value of a named optional parameter and convert it to a string.

Like opt_param, but returns Err if the parameter value cannot be converted to a String.

source

pub fn tagged_base64_param<Name>( &self, name: &Name ) -> Result<&TaggedBase64, RequestError>
where Name: ?Sized + Display,

Get the value of a named parameter and convert it to [TaggedBase64].

Like param, but returns Err if the parameter value cannot be converted to [TaggedBase64].

source

pub fn opt_tagged_base64_param<Name>( &self, name: &Name ) -> Result<Option<&TaggedBase64>, RequestError>
where Name: ?Sized + Display,

Get the value of a named optional parameter and convert it to [TaggedBase64].

Like opt_param, but returns Err if the parameter value cannot be converted to [TaggedBase64].

source

pub fn blob_param<'a, Name, T>(&'a self, name: &Name) -> Result<T, RequestError>
where Name: ?Sized + Display, T: TryFrom<&'a TaggedBase64>, <T as TryFrom<&'a TaggedBase64>>::Error: Display,

Get the value of a named parameter and convert it to a custom type through [TaggedBase64].

Like param, but returns Err if the parameter value cannot be converted to T.

source

pub fn opt_blob_param<'a, Name, T>( &'a self, name: &Name ) -> Result<Option<T>, RequestError>
where Name: ?Sized + Display, T: TryFrom<&'a TaggedBase64>, <T as TryFrom<&'a TaggedBase64>>::Error: Display,

Get the value of a named optional parameter and convert it to a custom type through [TaggedBase64].

Like opt_param, but returns Err if the parameter value cannot be converted to T.

source

pub fn body_bytes(&self) -> Vec<u8>

source

pub fn body_json<T>(&self) -> Result<T, RequestError>

source

pub fn body_auto<T, VER: StaticVersionType>( &self, _: VER ) -> Result<T, RequestError>

Deserialize the body of a request.

The Content-Type header is used to determine the serialization format.

Trait Implementations§

source§

impl Clone for RequestParams

source§

fn clone(&self) -> RequestParams

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for RequestParams

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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.

§

impl<T> Instrument for T

§

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

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

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.

§

impl<D> OwoColorize for D

§

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more
§

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more
§

fn black<'a>(&'a self) -> FgColorDisplay<'a, Black, Self>

Change the foreground color to black
§

fn on_black<'a>(&'a self) -> BgColorDisplay<'a, Black, Self>

Change the background color to black
§

fn red<'a>(&'a self) -> FgColorDisplay<'a, Red, Self>

Change the foreground color to red
§

fn on_red<'a>(&'a self) -> BgColorDisplay<'a, Red, Self>

Change the background color to red
§

fn green<'a>(&'a self) -> FgColorDisplay<'a, Green, Self>

Change the foreground color to green
§

fn on_green<'a>(&'a self) -> BgColorDisplay<'a, Green, Self>

Change the background color to green
§

fn yellow<'a>(&'a self) -> FgColorDisplay<'a, Yellow, Self>

Change the foreground color to yellow
§

fn on_yellow<'a>(&'a self) -> BgColorDisplay<'a, Yellow, Self>

Change the background color to yellow
§

fn blue<'a>(&'a self) -> FgColorDisplay<'a, Blue, Self>

Change the foreground color to blue
§

fn on_blue<'a>(&'a self) -> BgColorDisplay<'a, Blue, Self>

Change the background color to blue
§

fn magenta<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to magenta
§

fn on_magenta<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to magenta
§

fn purple<'a>(&'a self) -> FgColorDisplay<'a, Magenta, Self>

Change the foreground color to purple
§

fn on_purple<'a>(&'a self) -> BgColorDisplay<'a, Magenta, Self>

Change the background color to purple
§

fn cyan<'a>(&'a self) -> FgColorDisplay<'a, Cyan, Self>

Change the foreground color to cyan
§

fn on_cyan<'a>(&'a self) -> BgColorDisplay<'a, Cyan, Self>

Change the background color to cyan
§

fn white<'a>(&'a self) -> FgColorDisplay<'a, White, Self>

Change the foreground color to white
§

fn on_white<'a>(&'a self) -> BgColorDisplay<'a, White, Self>

Change the background color to white
§

fn default_color<'a>(&'a self) -> FgColorDisplay<'a, Default, Self>

Change the foreground color to the terminal default
§

fn on_default_color<'a>(&'a self) -> BgColorDisplay<'a, Default, Self>

Change the background color to the terminal default
§

fn bright_black<'a>(&'a self) -> FgColorDisplay<'a, BrightBlack, Self>

Change the foreground color to bright black
§

fn on_bright_black<'a>(&'a self) -> BgColorDisplay<'a, BrightBlack, Self>

Change the background color to bright black
§

fn bright_red<'a>(&'a self) -> FgColorDisplay<'a, BrightRed, Self>

Change the foreground color to bright red
§

fn on_bright_red<'a>(&'a self) -> BgColorDisplay<'a, BrightRed, Self>

Change the background color to bright red
§

fn bright_green<'a>(&'a self) -> FgColorDisplay<'a, BrightGreen, Self>

Change the foreground color to bright green
§

fn on_bright_green<'a>(&'a self) -> BgColorDisplay<'a, BrightGreen, Self>

Change the background color to bright green
§

fn bright_yellow<'a>(&'a self) -> FgColorDisplay<'a, BrightYellow, Self>

Change the foreground color to bright yellow
§

fn on_bright_yellow<'a>(&'a self) -> BgColorDisplay<'a, BrightYellow, Self>

Change the background color to bright yellow
§

fn bright_blue<'a>(&'a self) -> FgColorDisplay<'a, BrightBlue, Self>

Change the foreground color to bright blue
§

fn on_bright_blue<'a>(&'a self) -> BgColorDisplay<'a, BrightBlue, Self>

Change the background color to bright blue
§

fn bright_magenta<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright magenta
§

fn on_bright_magenta<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright magenta
§

fn bright_purple<'a>(&'a self) -> FgColorDisplay<'a, BrightMagenta, Self>

Change the foreground color to bright purple
§

fn on_bright_purple<'a>(&'a self) -> BgColorDisplay<'a, BrightMagenta, Self>

Change the background color to bright purple
§

fn bright_cyan<'a>(&'a self) -> FgColorDisplay<'a, BrightCyan, Self>

Change the foreground color to bright cyan
§

fn on_bright_cyan<'a>(&'a self) -> BgColorDisplay<'a, BrightCyan, Self>

Change the background color to bright cyan
§

fn bright_white<'a>(&'a self) -> FgColorDisplay<'a, BrightWhite, Self>

Change the foreground color to bright white
§

fn on_bright_white<'a>(&'a self) -> BgColorDisplay<'a, BrightWhite, Self>

Change the background color to bright white
§

fn bold<'a>(&'a self) -> BoldDisplay<'a, Self>

Make the text bold
§

fn dimmed<'a>(&'a self) -> DimDisplay<'a, Self>

Make the text dim
§

fn italic<'a>(&'a self) -> ItalicDisplay<'a, Self>

Make the text italicized
§

fn underline<'a>(&'a self) -> UnderlineDisplay<'a, Self>

Make the text italicized
Make the text blink
Make the text blink (but fast!)
§

fn reversed<'a>(&'a self) -> ReversedDisplay<'a, Self>

Swap the foreground and background colors
§

fn hidden<'a>(&'a self) -> HiddenDisplay<'a, Self>

Hide the text
§

fn strikethrough<'a>(&'a self) -> StrikeThroughDisplay<'a, Self>

Cross out the text
§

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more
§

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more
§

fn fg_rgb<const R: u8, const G: u8, const B: u8>( &self ) -> FgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the foreground color to a specific RGB value.
§

fn bg_rgb<const R: u8, const G: u8, const B: u8>( &self ) -> BgColorDisplay<'_, CustomColor<R, G, B>, Self>

Set the background color to a specific RGB value.
§

fn truecolor(&self, r: u8, g: u8, b: u8) -> FgDynColorDisplay<'_, Rgb, Self>

Sets the foreground color to an RGB value.
§

fn on_truecolor(&self, r: u8, g: u8, b: u8) -> BgDynColorDisplay<'_, Rgb, Self>

Sets the background color to an RGB value.
§

fn style(&self, style: Style) -> Styled<&Self>

Apply a runtime-determined style
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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