Enum FormatItem

#[non_exhaustive]
pub enum FormatItem<'a> {
    Literal(&'a [u8]),
    Component(Component),
    Compound(&'a [BorrowedFormatItem<'a>]),
    Optional(&'a BorrowedFormatItem<'a>),
    First(&'a [BorrowedFormatItem<'a>]),
}

A complete description of how to format and parse a type.

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.

Literal(&'a [u8])

Bytes that are formatted as-is.

Note: These bytes should be UTF-8, but are not required to be. The value is passed through String::from_utf8_lossy when necessary.

Component(Component)

A minimal representation of a single non-literal item.

Compound(&'a [BorrowedFormatItem<'a>])

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

Optional(&'a BorrowedFormatItem<'a>)

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

This variant has no effect on formatting, as the value is guaranteed to be present.

First(&'a [BorrowedFormatItem<'a>])

A series of FormatItems where, when parsing, the first successful parse is used. When formatting, the first element of the slice is used. An empty slice is a no-op when formatting or parsing.

Trait Implementations

impl<'a> Clone for BorrowedFormatItem<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BorrowedFormatItem<'_>

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

Formats the value using the given formatter.

impl<'a> From<&'a [BorrowedFormatItem<'_>]> for BorrowedFormatItem<'a>

fn from(items: &'a [BorrowedFormatItem<'_>]) -> BorrowedFormatItem<'a>

Converts to this type from the input type.

impl From<Component> for BorrowedFormatItem<'_>

fn from(component: Component) -> BorrowedFormatItem<'_>

Converts to this type from the input type.

impl PartialEq<&[BorrowedFormatItem<'_>]> for BorrowedFormatItem<'_>

fn eq(&self, rhs: &&[BorrowedFormatItem<'_>]) -> 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 PartialEq<BorrowedFormatItem<'_>> for &[BorrowedFormatItem<'_>]

fn eq(&self, rhs: &BorrowedFormatItem<'_>) -> 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 PartialEq<Component> for BorrowedFormatItem<'_>

fn eq(&self, rhs: &Component) -> 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<'a> PartialEq for BorrowedFormatItem<'a>

fn eq(&self, other: &BorrowedFormatItem<'a>) -> 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<'a> TryFrom<BorrowedFormatItem<'a>> for &[BorrowedFormatItem<'a>]

type Error = DifferentVariant

The type returned in the event of a conversion error.

fn try_from( value: BorrowedFormatItem<'a>, ) -> Result<&[BorrowedFormatItem<'a>], <&[BorrowedFormatItem<'a>] as TryFrom<BorrowedFormatItem<'a>>>::Error>

Performs the conversion.

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from( item: Item<'a>, ) -> Result<BorrowedFormatItem<'a>, <BorrowedFormatItem<'a> as TryFrom<Item<'a>>>::Error>

Performs the conversion.

impl<'a> Eq for BorrowedFormatItem<'a>

impl Formattable for BorrowedFormatItem<'_>

impl<'a> StructuralPartialEq for BorrowedFormatItem<'a>