Struct Codec

pub struct Codec<T>(pub T);

Codec extractor / response.

The serialized data is not specified. Upon deserialization, the request’s Content-Type header is used to determine the format of the data.

By default, only JSON is supported. To enable other formats, use the corresponding feature flags.

Note that IntoResponse is not implemented for this type, as the headers are not available when serializing the data. Instead, use Codec::to_response to create a response with the appropriate Content-Type header extracted from the request with Accept.

Examples

#[axum_codec::apply(decode)]
struct Greeting {
  hello: String,
}

let bytes = b"{\"hello\": \"world\"}";
let content_type = ContentType::Json;

let Codec(data) = Codec::<Greeting>::from_bytes(bytes, content_type).unwrap();

assert_eq!(data.hello, "world");

Tuple Fields

0: T

Implementations

impl<T> Codec<T>

where T: DeserializeOwned,

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

Attempts to deserialize the given bytes as JSON.

Errors

See serde_json::from_slice.

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

Attempts to deserialize the given bytes as MessagePack. Does not perform any validation if the validator feature is enabled. For validation, use Self::from_bytes.

Errors

See rmp_serde::from_slice.

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

Attemps to deserialize the given bytes as CBOR. Does not perform any validation if the validator feature is enabled. For validation, use Self::from_bytes.

Errors

See [ciborium::from_slice].

pub fn from_yaml(text: &str) -> Result<Self, Error>

Attempts to deserialize the given text as YAML. Does not perform any validation if the validator feature is enabled. For validation, use Self::from_bytes.

Errors

See serde_yaml::from_slice.

pub fn from_toml(text: &str) -> Result<Self, Error>

Attempts to deserialize the given text as TOML. Does not perform any validation if the validator feature is enabled. For validation, use Self::from_bytes.

Errors

See toml::from_str.

impl<T> Codec<T>

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

where T: Decode,

Attempts to deserialize the given bytes as Bincode. Does not perform any validation if the validator feature is enabled. For validation, use Self::from_bytes.

Errors

See bincode::decode_from_slice.

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

where T: DecodeOwned,

Attempts to deserialize the given bytes as Bitcode. Does not perform any validation if the validator feature is enabled. For validation, use Self::from_bytes.

Errors

See bitcode::decode.

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

where T: CodecDecode,

Attempts to deserialize the given bytes as the specified ContentType.

Errors

See CodecRejection.

impl<T> Codec<T>

where T: Serialize,

pub fn to_json(&self) -> Result<Vec<u8>, Error>

Attempts to serialize the given value as JSON.

Errors

See serde_json::to_vec.

pub fn to_msgpack(&self) -> Result<Vec<u8>, Error>

Attempts to serialize the given value as MessagePack.

Errors

See rmp_serde::to_vec_named.

pub fn to_cbor(&self) -> Result<Vec<u8>, Error<Error>>

Attempts to serialize the given value as CBOR.

Errors

See ciborium::into_writer.

pub fn to_yaml(&self) -> Result<String, Error>

Attempts to serialize the given value as YAML.

Errors

See [serde_yaml::to_vec].

pub fn to_toml(&self) -> Result<String, Error>

Attempts to serialize the given value as TOML.

Errors

See toml::to_string.

impl<T> Codec<T>

pub fn to_bincode(&self) -> Result<Vec<u8>, EncodeError>

where T: Encode,

Attempts to serialize the given value as Bincode

Errors

See [bincode::serialize].

pub fn to_bitcode(&self) -> Vec<u8>

where T: Encode,

Attempts to serialize the given value as Bitcode

Errors

See bitcode::encode.

pub fn to_bytes(&self, content_type: ContentType) -> Result<Vec<u8>, Error>

where T: CodecEncode,

Attempts to serialize the given value as the specified ContentType.

Errors

See [Error].

impl<T> Codec<T>

where T: CodecEncode,

pub fn into_inner(self) -> T

Consumes the Codec and returns the inner value.

pub fn to_response<C: Into<ContentType>>(&self, content_type: C) -> Response

Converts the inner value into a response with the given content type.

If serialization fails, the rejection is converted into a response. See encode::Error for possible errors.

Trait Implementations

impl<T> Deref for Codec<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Codec<T>

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

Mutably dereferences the value.

impl<T: Display> Display for Codec<T>

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

Formats the value using the given formatter.

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

where T: CodecDecode, S: Send + Sync + 'static,

type Rejection = Response<Body>

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<D> IntoCodecResponse for Codec<D>

where D: CodecEncode, Self: OperationOutput,

fn into_codec_response(self, content_type: ContentType) -> Response

impl<T> OperationInput for Codec<T>

where T: JsonSchema,

fn operation_input(ctx: &mut GenContext, operation: &mut Operation)

Modify the operation.

fn inferred_early_responses( ctx: &mut GenContext, operation: &mut Operation, ) -> Vec<(Option<u16>, Response)>

Inferred early responses are used to document early returns for extractors, guards inside handlers. For example these could represent JSON parsing errors, authentication failures.

impl<T> OperationOutput for Codec<T>

where T: JsonSchema,

type Inner = T

The type that is used in examples.

fn operation_response( ctx: &mut GenContext, operation: &mut Operation, ) -> Option<Response>

Return a response documentation for this type, alternatively modify the operation if required.

fn inferred_responses( ctx: &mut GenContext, operation: &mut Operation, ) -> Vec<(Option<u16>, Response)>

Inferred responses are used when the type is used as a request handler return type.

impl<T> Validate for Codec<T>

where T: Validate,

fn validate(&self) -> Result<(), ValidationErrors>