Module axum_valid::extra::protobuf

Support for Protobuf<T> from axum-extra

Feature

Enable the extra_protobuf feature to use Valid<Protobuf<T>>.

Usage

1. Implement prost::Message and Validate for your data type T.
2. In your handler function, use Valid<Protobuf<T>> as some parameter’s type.

Example

#[cfg(feature = "validator")]
mod validator_example {
    use axum::routing::post;
    use axum_extra::protobuf::Protobuf;
    use axum::Router;
    use axum_valid::Valid;
    use serde::Deserialize;
    use validator::Validate;

    pub fn router() -> Router {
        Router::new().route("/protobuf", post(handler))
    }

    async fn handler(Valid(Protobuf(parameter)): Valid<Protobuf<Parameter>>) {
        assert!(parameter.validate().is_ok());
        // Support automatic dereferencing
        println!("v0 = {}, v1 = {}", parameter.v0, parameter.v1);
    }

    #[derive(Validate, prost::Message)]
    pub struct Parameter {
        #[validate(range(min = 5, max = 10))]
        #[prost(int32, tag = "1")]
        pub v0: i32,
        #[validate(length(min = 1, max = 10))]
        #[prost(string, tag = "2")]
        pub v1: String,
    }
}

#[cfg(feature = "garde")]
mod garde_example {
    use axum::routing::post;
    use axum::Router;
    use axum_extra::protobuf::Protobuf;
    use axum_valid::Garde;
    use serde::Deserialize;
    use garde::Validate;

    pub fn router() -> Router {
        Router::new().route("/protobuf", post(handler))
    }

    async fn handler(Garde(Protobuf(parameter)): Garde<Protobuf<Parameter>>) {
        assert!(parameter.validate(&()).is_ok());
        // Support automatic dereferencing
        println!("v0 = {}, v1 = {}", parameter.v0, parameter.v1);
    }

    #[derive(Validate, prost::Message)]
    pub struct Parameter {
        #[garde(range(min = 5, max = 10))]
        #[prost(int32, tag = "1")]
        pub v0: i32,
        #[garde(length(min = 1, max = 10))]
        #[prost(string, tag = "2")]
        pub v1: String,
    }
}