Enum Format 

#[repr(u8)]
pub enum Format {
    Json,
    Json5,
    Toml {
        inline_width: InlineWidth,
    },
    Yaml,
}

Output syntax for a structured document.

Variants

Json

JSON.

Json5

JSON5, with unquoted keys, comments, and literal strings.

Toml

TOML.

Fields

inline_width: InlineWidth

Column limit for rendering a table as an inline table.

Yaml

YAML.

Implementations

impl Format

pub fn from_extension( extension: &str, inline_width: InlineWidth, ) -> Option<Self>

The format of a file with this extension, without the dot. TOML needs the inline width the caller wants.

fn run<R: Run>(self, operation: R) -> R::Output

pub(crate) fn reconcile( self, desired: &Annotated, source: &Source<'_>, ownership: &Ownership, ) -> Result<Vec<u8>, DocumentError>

Reconcile a desired value against the current source.

Errors

Returns an error for malformed source, values the format cannot represent, or an incompatible merge.

pub fn read_string( self, source: &str, path: &ManagedPath, ) -> Result<Option<String>, DocumentError>

The string at path in source. A key that is absent on the way gives None.

Errors

Returns an error for malformed source, and ValueError::NotString when the value at path is not a string. YAML returns the text of any scalar, including numbers and booleans.

pub(crate) const fn supports(self, feature: Feature) -> bool

Whether the format can express feature at all.

A literal string can still fail when the format cannot reproduce its text.

pub(crate) fn reproduces_literal(self, text: &str) -> bool

Whether the format can write text as a literal string.

pub(crate) const fn reject(self, feature: Feature) -> ValueError

The error for a feature this format cannot express.

pub(crate) const fn require(self, feature: Feature) -> Result<(), ValueError>

Check that the format supports feature.

Errors

Returns ValueError::Unsupported when it does not.

Trait Implementations

impl Clone for Format

fn clone(&self) -> Format

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Format

impl Debug for Format

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

Formats the value using the given formatter.

impl Display for Format

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

Formats the value using the given formatter.

impl Eq for Format

impl<'ʄ> Facet<'ʄ> for Format

const SHAPE: &'static Shape

The shape of this type, including: whether it’s a Struct, an Enum, something else?

impl PartialEq for Format

fn eq(&self, other: &Format) -> bool

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Format