Struct salvo_oapi::extract::QueryParam

source · 
pub struct QueryParam<T, const REQUIRED: bool>(/* private fields */);
Expand description

Represents the parameters passed by the URI path.

Implementations§

source§

impl<T> QueryParam<T, true>

source

pub fn into_inner(self) -> T

Consumes self and returns the value of the parameter.

source§

impl<T> QueryParam<T, false>

source

pub fn into_inner(self) -> Option<T>

Consumes self and returns the value of the parameter.

Trait Implementations§

source§

impl<T, const R: bool> Debug for QueryParam<T, R>
where T: Debug,

source§

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

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

impl<T> Deref for QueryParam<T, false>

§

type Target = Option<T>

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl<T> Deref for QueryParam<T, true>

§

type Target = T

The resulting type after dereferencing.
source§

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

Dereferences the value.
source§

impl<T> DerefMut for QueryParam<T, false>

source§

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

Mutably dereferences the value.
source§

impl<T> DerefMut for QueryParam<T, true>

source§

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

Mutably dereferences the value.
source§

impl<'de, T, const R: bool> Deserialize<'de> for QueryParam<T, R>
where T: Deserialize<'de>,

source§

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
source§

impl<T> Display for QueryParam<T, true>
where T: Display,

source§

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

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

impl<T, const R: bool> EndpointArgRegister for QueryParam<T, R>
where T: ToSchema,

source§

fn register(components: &mut Components, operation: &mut Operation, arg: &str)

Modify the OpenApi components section or current operation information with given argument. This function is called by macros internal.
source§

impl<'ex, T> Extractible<'ex> for QueryParam<T, false>
where T: Deserialize<'ex>,

source§

fn metadata() -> &'ex Metadata

Metadata for Extractible type.
source§

async fn extract(_req: &'ex mut Request) -> Result<Self, ParseError>

Extract data from request. Read more
source§

async fn extract_with_arg( req: &'ex mut Request, arg: &str, ) -> Result<Self, ParseError>

Extract data from request with a argument. This function used in macros internal.
source§

impl<'ex, T> Extractible<'ex> for QueryParam<T, true>
where T: Deserialize<'ex>,

source§

fn metadata() -> &'ex Metadata

Metadata for Extractible type.
source§

async fn extract(_req: &'ex mut Request) -> Result<Self, ParseError>

Extract data from request. Read more
source§

async fn extract_with_arg( req: &'ex mut Request, arg: &str, ) -> Result<Self, ParseError>

Extract data from request with a argument. This function used in macros internal.

Auto Trait Implementations§

§

impl<T, const REQUIRED: bool> Freeze for QueryParam<T, REQUIRED>
where T: Freeze,

§

impl<T, const REQUIRED: bool> RefUnwindSafe for QueryParam<T, REQUIRED>
where T: RefUnwindSafe,

§

impl<T, const REQUIRED: bool> Send for QueryParam<T, REQUIRED>
where T: Send,

§

impl<T, const REQUIRED: bool> Sync for QueryParam<T, REQUIRED>
where T: Sync,

§

impl<T, const REQUIRED: bool> Unpin for QueryParam<T, REQUIRED>
where T: Unpin,

§

impl<T, const REQUIRED: bool> UnwindSafe for QueryParam<T, REQUIRED>
where T: 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<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. 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.
source§

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

source§

fn vzip(self) -> V

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

source§

impl<T> Formattable for T
where T: Deref, <T as Deref>::Target: Formattable,

source§

impl<T> Parsable for T
where T: Deref, <T as Deref>::Target: Parsable,