Module salvo_core::extract

Extract is a feature to let you deserialize request to custom type.

You can easily get data from multiple different data sources and assemble it into the type you want. You can define a custom type first, then in Handler you can get the data like this:

#[derive(Serialize, Deserialize, Extractible, Debug)]
// Get the data field value from the body by default.
#[salvo(extract(default_source(from = "body")))]
struct GoodMan<'a> {
    /// The id number is obtained from the request path parameter, and the data is automatically parsed as i64 type.
    #[salvo(extract(source(from = "param")))]
    id: i64,
    /// Reference types can be used to avoid memory copying.
    username: &'a str,
    first_name: String,
    last_name: String,
}

#[handler]
async fn edit(req: &mut Request) {
    let good_man: GoodMan<'_> = req.extract().await.unwrap();
}

There is considerable flexibility in the definition of data types, and can even be resolved into nested structures as needed:

#[derive(Serialize, Deserialize, Extractible, Debug)]
#[salvo(extract(default_source(from = "body")))]
struct GoodMan<'a> {
    #[salvo(extract(source(from = "param")))]
    id: i64,
    #[salvo(extract(source(from = "query")))]
    username: &'a str,
    first_name: String,
    last_name: String,
    lovers: Vec<String>,
    /// The nested field is completely reparsed from Request.
    #[serde(flatten)]
    nested: Nested<'a>,
}

#[derive(Serialize, Deserialize, Extractible, Debug)]
#[salvo(extract(default_source(from = "body")))]
struct Nested<'a> {
    #[salvo(extract(source(from = "param")))]
    id: i64,
    #[salvo(extract(source(from = "query")))]
    username: &'a str,
    first_name: String,
    last_name: String,
    #[salvo(rename = "lovers")]
    #[serde(default)]
    pets: Vec<String>,
}

View full source code

Re-exports

• pub use metadata::Metadata;

Modules

• metadata
  Metadata types.

Enums

• RenameRule
  Rename rule for a field.

Traits

• Extractible
  If a type implements this trait, it will give a metadata, this will help request to extracts data to this type.