Trait Codec

pub trait Codec {
    type EncodeError: Error + Send + Sync + 'static;
    type DecodeError: Error + Send + Sync + 'static;

    const EXTENSION: &'static str;

    // Required methods
    fn encode(
        writer: impl Write,
        profile: &Profile<'_>,
    ) -> Result<(), Self::EncodeError>;
    fn decode(slice: &[u8]) -> Result<Profile<'_>, Self::DecodeError>;
}

A codec for encoding and decoding profiles.

Required Associated Constants

const EXTENSION: &'static str

The file extension for this codec.

Required Associated Types

type EncodeError: Error + Send + Sync + 'static

The error type for encoding.

type DecodeError: Error + Send + Sync + 'static

The error type for decoding.

Required Methods

fn encode( writer: impl Write, profile: &Profile<'_>, ) -> Result<(), Self::EncodeError>

Encodes a profile into the given writer.

fn decode(slice: &[u8]) -> Result<Profile<'_>, Self::DecodeError>

Decodes a profile from the given slice.

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 Codec for BincodeCodec

const EXTENSION: &'static str = "bin"

type EncodeError = EncodeError

type DecodeError = DecodeError

impl Codec for JsonCodec

const EXTENSION: &'static str = "json"

type EncodeError = Error

type DecodeError = Error

impl Codec for MsgpackCodec

const EXTENSION: &'static str = "msgpack"

type EncodeError = Error

type DecodeError = Error