Enum OwnedFormatItem

#[non_exhaustive]
pub enum OwnedFormatItem {
    Literal(Box<[u8]>),
    Component(Component),
    Compound(Box<[Self]>),
    Optional(Box<Self>),
    First(Box<[Self]>),
}

Available on crate feature alloc and (crate features formatting or parsing) only.

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(Box<[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(Box<[Self]>)

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

Optional(Box<Self>)

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(Box<[Self]>)

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

Trait Implementations

impl Clone for OwnedFormatItem

fn clone(&self) -> OwnedFormatItem

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedFormatItem

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

Formats the value using the given formatter.

impl From<&BorrowedFormatItem<'_>> for OwnedFormatItem

fn from(item: &BorrowedFormatItem<'_>) -> Self

Converts to this type from the input type.

impl<'a, T: AsRef<[BorrowedFormatItem<'a>]> + ?Sized> From<&T> for OwnedFormatItem

fn from(items: &T) -> Self

Converts to this type from the input type.

impl From<BorrowedFormatItem<'_>> for OwnedFormatItem

fn from(item: BorrowedFormatItem<'_>) -> Self

Converts to this type from the input type.

impl<'a> From<Box<[Item<'a>]>> for OwnedFormatItem

fn from(items: Box<[Item<'a>]>) -> Self

Converts to this type from the input type.

impl From<Component> for OwnedFormatItem

fn from(component: Component) -> Self

Converts to this type from the input type.

impl From<Vec<BorrowedFormatItem<'_>>> for OwnedFormatItem

fn from(items: Vec<BorrowedFormatItem<'_>>) -> Self

Converts to this type from the input type.

impl From<Vec<OwnedFormatItem>> for OwnedFormatItem

fn from(items: Vec<Self>) -> Self

Converts to this type from the input type.

impl PartialEq<&[OwnedFormatItem]> for OwnedFormatItem

fn eq(&self, rhs: &&[Self]) -> 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 OwnedFormatItem

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 PartialEq<OwnedFormatItem> for &[OwnedFormatItem]

fn eq(&self, rhs: &OwnedFormatItem) -> 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<OwnedFormatItem> for Component

fn eq(&self, rhs: &OwnedFormatItem) -> 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 for OwnedFormatItem

fn eq(&self, other: &OwnedFormatItem) -> 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 TryFrom<OwnedFormatItem> for Component

type Error = DifferentVariant

The type returned in the event of a conversion error.

fn try_from(value: OwnedFormatItem) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<OwnedFormatItem> for Vec<OwnedFormatItem>

type Error = DifferentVariant

The type returned in the event of a conversion error.

fn try_from(value: OwnedFormatItem) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for OwnedFormatItem

impl Formattable for OwnedFormatItem

Available on crate feature formatting only.

impl Parsable for OwnedFormatItem

Available on crate feature parsing only.

impl StructuralPartialEq for OwnedFormatItem