Trait Format

pub trait Format {
    type Output<T>;
    type Input<T>: ?Sized;

    // Required methods
    fn deserialise<T>(rdr: &mut dyn Read) -> Result<Self::Output<T>>
       where for<'de> T: Deserialize<'de>;
    fn serialise<T>(wtr: &mut dyn Write, val: &Self::Input<T>) -> Result<()>
       where T: Serialize;
}

Defines a structured format which can be used with ReadAs/WriteAs.

A format needs to describe (de)serialisation mechanism, along with the input/output types. Note the use of GATs, this can be leveraged to work with containerised types.

Required Associated Types

type Output<T>

The resulting type after deserialisation.

type Input<T>: ?Sized

The input for serialisation.

Note that this is passed through as a reference to serialise.

Required Methods

fn deserialise<T>(rdr: &mut dyn Read) -> Result<Self::Output<T>>

where for<'de> T: Deserialize<'de>,

Deserialise from rdr into Output.

fn serialise<T>(wtr: &mut dyn Write, val: &Self::Input<T>) -> Result<()>

where T: Serialize,

Serialise val into wtr.

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 Format for CSV

type Output<T> = Vec<T>

type Input<T> = [T]

impl Format for JSON

type Output<T> = T

type Input<T> = T

impl Format for TOML

type Output<T> = T

type Input<T> = T