Struct Toml

pub struct Toml<const PRETTY: bool = true>;

Available on crate feature toml-serde only.

A FileFormat corresponding to the TOML data format. Implemented using the toml crate, only compatible with serde types.

This type provides an optional constant generic parameter for configuring pretty-print.

Trait Implementations

impl<const PRETTY: bool> Clone for Toml<PRETTY>

fn clone(&self) -> Toml<PRETTY>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<const PRETTY: bool> Debug for Toml<PRETTY>

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

Formats the value using the given formatter.

impl<const PRETTY: bool> Default for Toml<PRETTY>

fn default() -> Toml<PRETTY>

Returns the “default value” for a type.

impl<T, const PRETTY: bool> FileFormat<T> for Toml<PRETTY>

where T: Serialize + DeserializeOwned,

Since the toml crate exposes no writer-based operations, all operations within this implementation are buffered.

type FormatError = TomlError

The type of error to return from to_writer and from_reader.

fn from_reader<R: Read>(&self, reader: R) -> Result<T, Self::FormatError>

Deserialize a value from a Read stream.

fn from_reader_buffered<R: Read>( &self, reader: R, ) -> Result<T, Self::FormatError>

Identical to FileFormat::from_reader, however the provided reader is buffered with BufReader.

fn to_writer<W: Write>( &self, writer: W, value: &T, ) -> Result<(), Self::FormatError>

Serialize a value into a Write stream.

fn to_writer_buffered<W: Write>( &self, writer: W, value: &T, ) -> Result<(), Self::FormatError>

Identical to FileFormat::to_writer, however the provided writer is buffered with BufWriter.

fn to_buffer(&self, value: &T) -> Result<Vec<u8>, Self::FormatError>

Serialize a value into a byte vec.

fn from_buffer(&self, buf: &[u8]) -> Result<T, Self::FormatError>

Deserialize a value from a byte vec.

impl<const PRETTY: bool> PartialEq for Toml<PRETTY>

fn eq(&self, other: &Toml<PRETTY>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<const PRETTY: bool> Copy for Toml<PRETTY>

impl<const PRETTY: bool> Eq for Toml<PRETTY>

impl<const PRETTY: bool> StructuralPartialEq for Toml<PRETTY>