Enum FormatDescriptionV3Inner 

#[non_exhaustive]
pub enum FormatDescriptionV3Inner<'a> {
    Component(Component),
    BorrowedLiteral(&'a str),
    BorrowedCompound(&'a [Self]),
    BorrowedOptional {
        format: bool,
        item: &'a Self,
    },
    BorrowedFirst(&'a [Self]),
    OwnedLiteral(Box<str>),
    OwnedCompound(Box<[Self]>),
    OwnedOptional {
        format: bool,
        item: Box<Self>,
    },
    OwnedFirst(Box<[Self]>),
}

Available on crate features formatting or parsing only.

The inner enum of a version 3 format description. Controls all business logic.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Component(Component)

A minimal representation of a single non-literal item.

BorrowedLiteral(&'a str)

A string that is formatted as-is.

BorrowedCompound(&'a [Self])

A series of literals or components that collectively form a partial or complete description.

BorrowedOptional

An item that may or may not be present when parsing. If parsing fails, there will be no effect on the resulting struct.

Fields

format: bool

Whether the item should be formatted.

item: &'a Self

The item in question.

BorrowedFirst(&'a [Self])

A series of items where, when parsing, the first successful parse is used. When formatting, the first item is used. If no items are present, both formatting and parsing are no-ops.

OwnedLiteral(Box<str>)

Available on crate feature alloc only.

A string that is formatted as-is.

OwnedCompound(Box<[Self]>)

Available on crate feature alloc only.

A series of literals or components that collectively form a partial or complete description.

OwnedOptional

Available on crate feature alloc only.

An item that may or may not be present when parsing. If parsing fails, there will be no effect on the resulting struct.

Fields

format: bool

Whether the item should be formatted.

item: Box<Self>

The item in question.

OwnedFirst(Box<[Self]>)

Available on crate feature alloc only.

A series of items where, when parsing, the first successful parse is used. When formatting, the first item is used. If no items are present, both formatting and parsing are no-ops.

Implementations

impl<'a> FormatDescriptionV3Inner<'a>

fn to_owned(&self) -> FormatDescriptionV3Inner<'static>

Available on crate feature alloc only.

Convert the format description to an owned version, enabling it to be stored without regard for lifetime.

pub const fn into_opaque(self) -> FormatDescriptionV3<'a>

Convert the inner enum to a FormatDescriptionV3.

const fn max_bytes_needed(&self) -> usize

Available on crate feature formatting only.

Obtain the maximum number of bytes that are needed to format any value using this format description.

Trait Implementations

impl<'a> Clone for FormatDescriptionV3Inner<'a>

fn clone(&self) -> FormatDescriptionV3Inner<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComputeMetadata for FormatDescriptionV3Inner<'_>

Available on crate feature formatting only.

fn compute_metadata(&self) -> Metadata

Compute the metadata for a format description.

impl Debug for FormatDescriptionV3Inner<'_>

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

Formats the value using the given formatter.

impl Sealed for FormatDescriptionV3Inner<'_>

Available on crate feature formatting only.

fn format_into<V>( &self, output: &mut (impl Write + ?Sized), value: &V, state: &mut V::State, ) -> Result<usize, Format>

where V: ComponentProvider,

Format the item into the provided output, returning the number of bytes written.

fn format<V>(&self, value: &V, state: &mut V::State) -> Result<String, Format>

where V: ComponentProvider,

Format the item directly to a String.

impl<'a> TryFrom<Box<[Item<'a>]>> for FormatDescriptionV3Inner<'a>

Available on crate feature alloc only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(items: Box<[Item<'a>]>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<Item<'a>> for FormatDescriptionV3Inner<'a>

Available on crate feature alloc only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(item: Item<'a>) -> Result<Self, Self::Error>

Performs the conversion.