Struct Field

#[non_exhaustive]
pub struct Field {
    pub decl_name: &'static str,
    pub flatten: bool,
    pub sources: Vec<Source>,
    pub aliases: Vec<&'static str>,
    pub rename: Option<&'static str>,
    pub serde_rename: Option<&'static str>,
    pub metadata: Option<&'static Metadata>,
}

Information about struct field.

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.

decl_name: &'static str

Field declare name in struct definition.

flatten: bool

Field flatten, this field will extracted from request.

sources: Vec<Source>

Field sources.

aliases: Vec<&'static str>

Field aliaes.

rename: Option<&'static str>

Field rename defined by #[derive(salvo(extract(rename="")))].

serde_rename: Option<&'static str>

Field rename defined by #[derive(serde(rename=""))].

metadata: Option<&'static Metadata>

Field metadata, this is used for nested extractible types.

Implementations

impl Field

pub fn new(decl_name: &'static str) -> Field

Create a new field with the given name and kind.

pub fn with_sources(decl_name: &'static str, sources: Vec<Source>) -> Field

Create a new field with the given name and kind, and the given sources.

pub fn flatten(self, flatten: bool) -> Field

Sets the flatten to the given value.

pub fn metadata(self, metadata: &'static Metadata) -> Field

Sets the metadata to the field type.

pub fn add_source(self, source: Source) -> Field

Add a source to sources list.

pub fn aliases(self, aliases: Vec<&'static str>) -> Field

Sets the aliases list to a new value.

pub fn add_alias(self, alias: &'static str) -> Field

Add a alias to aliases list.

pub fn rename(self, rename: &'static str) -> Field

Sets the rename to the given value.

pub fn serde_rename(self, serde_rename: &'static str) -> Field

Sets the rename to the given value.

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.