Trait PayloadCodec

pub trait PayloadCodec {
    // Required methods
    fn codec_name() -> &'static str;
    fn payload_encoding() -> PayloadEncoding;

    // Provided method
    fn verify_encoding(
        actual: Option<&PayloadEncoding>,
    ) -> Result<(), UWireError> { ... }
}

Payload-layer codec identity used by typed frame helpers.

Required Methods

fn codec_name() -> &'static str

Stable codec name for logs, diagnostics, and configuration.

fn payload_encoding() -> PayloadEncoding

Payload encoding metadata written into frames that use this codec.

Provided Methods

fn verify_encoding(actual: Option<&PayloadEncoding>) -> Result<(), UWireError>

Verifies frame encoding metadata against this codec.

Errors

Returns an error if the frame is missing payload encoding metadata or if the metadata is incompatible with this codec.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl<F> PayloadCodec for F

where F: PayloadFormat,

impl<T> PayloadCodec for StableContainerPayload<T>

where T: StablePayload,