Enum OwnedFormatItem 

#[non_exhaustive]
pub enum OwnedFormatItem {
    Literal(Box<[u8]>),
    StringLiteral(Box<str>),
    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]>)

👎Deprecated since 0.3.48:

use StringLiteral instead; raw bytes are not recommended

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.

StringLiteral(Box<str>)

A string that is formatted as-is.

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 AnyFormatItem for OwnedFormatItem

Available on crate feature parsing only.

fn parse_item<'a>( &self, parsed: &mut Parsed, input: &'a [u8], ) -> Result<&'a [u8], ParseFromDescription>

Parse a single item, returning the remaining input on success.

impl Clone for OwnedFormatItem

fn clone(&self) -> OwnedFormatItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComputeMetadata for OwnedFormatItem

Available on crate feature formatting only.

fn compute_metadata(&self, _: PrivateMethod) -> Metadata

Compute the metadata for a format description.

impl Debug for OwnedFormatItem

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

Formats the value using the given formatter.

impl Eq for OwnedFormatItem

#[doc(hidden)]

fn assert_fields_are_eq(&self)

🔬This is a nightly-only experimental API. (derive_eq_internals)

#[doc(hidden)]

fn assert_receiver_is_total_eq(&self)

👎Deprecated since 1.95.0:

implementation detail of #[derive(Eq)]

impl Formattable for OwnedFormatItem

Available on crate feature formatting only.

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

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

Converts to this type from the input type.

impl<'a, T> From<&T> for OwnedFormatItem

where T: AsRef<[BorrowedFormatItem<'a>]> + ?Sized,

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 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 Parsable for OwnedFormatItem

Available on crate feature parsing only.

impl PartialEq for OwnedFormatItem

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

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<&[OwnedFormatItem]> for OwnedFormatItem

fn eq(&self, rhs: &&[Self]) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<Component> for OwnedFormatItem

fn eq(&self, rhs: &Component) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<OwnedFormatItem> for Component

fn eq(&self, rhs: &OwnedFormatItem) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialEq<OwnedFormatItem> for &[OwnedFormatItem]

fn eq(&self, rhs: &OwnedFormatItem) -> bool

Equality operator ==.

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

Inequality operator !=.

impl Sealed for OwnedFormatItem

Available on crate feature formatting only.

fn format_into<V>( &self, output: &mut (impl Write + ?Sized), value: &V, state: &mut V::State, _: PrivateMethod, ) -> 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, _: PrivateMethod, ) -> Result<String, Format>

where V: ComponentProvider,

Format the item directly to a String.

impl Sealed for OwnedFormatItem

Available on crate feature parsing only.

fn parse_into<'a>( &self, input: &'a [u8], parsed: &mut Parsed, _: PrivateMethod, ) -> Result<&'a [u8], Parse>

Parse the item into the provided Parsed struct.

#[doc(hidden)]

fn parse(&self, input: &[u8]) -> Result<Parsed, Parse>

👎Deprecated since 0.3.53:

use the parse method on the target type; this method has never been part of the public API and will be removed in a future release

DO NOT USE THIS METHOD

fn parse_internal( &self, input: &[u8], defaults: Option<Parsed>, _: PrivateMethod, ) -> Result<Parsed, Parse>

Parse the items into a Parsed struct, using the provided defaults for any components that are not present in the input.

fn parse_date( &self, input: &[u8], defaults: Option<Parsed>, _: PrivateMethod, ) -> Result<Date, Parse>

Parse a Date from the format description.

fn parse_time( &self, input: &[u8], defaults: Option<Parsed>, _: PrivateMethod, ) -> Result<Time, Parse>

Parse a Time from the format description.

fn parse_offset( &self, input: &[u8], defaults: Option<Parsed>, _: PrivateMethod, ) -> Result<UtcOffset, Parse>

Parse a UtcOffset from the format description.

fn parse_plain_date_time( &self, input: &[u8], defaults: Option<Parsed>, _: PrivateMethod, ) -> Result<PlainDateTime, Parse>

Parse a PlainDateTime from the format description.

fn parse_utc_date_time( &self, input: &[u8], defaults: Option<Parsed>, _: PrivateMethod, ) -> Result<UtcDateTime, Parse>

Parse a UtcDateTime from the format description.

fn parse_offset_date_time( &self, input: &[u8], defaults: Option<Parsed>, _: PrivateMethod, ) -> Result<OffsetDateTime, Parse>

Parse a OffsetDateTime from the format description.

fn parse_timestamp( &self, input: &[u8], defaults: Option<Parsed>, _: PrivateMethod, ) -> Result<Timestamp, Parse>

Parse a Timestamp from the format description.

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.