Struct axum_yaml::yaml::Yaml

pub struct Yaml<T>(pub T);

YAML Extractor / Response.

When used as an extractor, it can deserialize request bodies into some type that implements serde::Deserialize. If the request body cannot be parsed, or it does not contain the Content-Type: application/yaml header, it will reject the request and return a 400 Bad Request response.

Extractor example

use axum::{
    extract,
    routing::post,
    Router,
};
use axum_yaml::Yaml;
use serde::Deserialize;

#[derive(Deserialize)]
struct CreateUser {
    email: String,
    password: String,
}

async fn create_user(Yaml(payload): Yaml<CreateUser>) {
    // payload is a `CreateUser`
}

let app = Router::new().route("/users", post(create_user));

When used as a response, it can serialize any type that implements serde::Serialize to YAML, and will automatically set Content-Type: application/yaml header.

Response example

use axum::{
    extract::Path,
    routing::get,
    Router,
};
use axum_yaml::Yaml;
use serde::Serialize;
use uuid::Uuid;

#[derive(Serialize)]
struct User {
    id: Uuid,
    username: String,
}

async fn get_user(Path(user_id) : Path<Uuid>) -> Yaml<User> {
    let user = find_user(user_id).await;
    Yaml(user)
}

async fn find_user(user_id: Uuid) -> User {
    // ...
}

let app = Router::new().route("/users/:id", get(get_user));

Tuple Fields

0: T

Implementations

impl<T> Yaml<T>

where T: DeserializeOwned,

pub fn from_bytes(bytes: &[u8]) -> Result<Self, YamlRejection>

Construct a Yaml<T> from a byte slice. Most users should prefer to use the FromRequest impl but special cases may require first extracting a Request into Bytes then optionally constructing a Yaml<T>.

Trait Implementations

impl<T: Clone> Clone for Yaml<T>

fn clone(&self) -> Yaml<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Yaml<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Yaml<T>

fn default() -> Yaml<T>

Returns the “default value” for a type.

impl<T> Deref for Yaml<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Yaml<T>

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

Mutably dereferences the value.

impl<T> From<T> for Yaml<T>

fn from(inner: T) -> Self

Converts to this type from the input type.

impl<T, S> FromRequest<S> for Yaml<T>

where T: DeserializeOwned, S: Send + Sync,

type Rejection = YamlRejection

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

fn from_request<'life0, 'async_trait>( req: Request, state: &'life0 S ) -> Pin<Box<dyn Future<Output = Result<Self, Self::Rejection>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Perform the extraction.

impl<T> IntoResponse for Yaml<T>

where T: Serialize,

fn into_response(self) -> Response

Create a response.

impl<T: Copy> Copy for Yaml<T>