Struct ParamFieldDescriptor 

#[non_exhaustive]
pub struct ParamFieldDescriptor {
    pub key: String,
    pub schema: SchemaContract,
    pub required: bool,
}

Opt-in per-field parameter declaration on an interaction. Declared fields get strict typed parsing on GET query strings and per-field body validation on mutating methods; undeclared keys pass through untyped.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

key: String

schema: SchemaContract

required: bool

Implementations

impl ParamFieldDescriptor

pub fn new( key: impl Into<String>, schema: SchemaContract, ) -> ParamFieldDescriptor

pub fn required(self) -> ParamFieldDescriptor

Trait Implementations

impl Clone for ParamFieldDescriptor

fn clone(&self) -> ParamFieldDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamFieldDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ParamFieldDescriptor

fn deserialize<__D>( __deserializer: __D, ) -> Result<ParamFieldDescriptor, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ParamFieldDescriptor

impl PartialEq for ParamFieldDescriptor

fn eq(&self, other: &ParamFieldDescriptor) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ParamFieldDescriptor

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ParamFieldDescriptor