#[non_exhaustive]
pub enum FormatItem<'a> {
    Literal(&'a [u8]),
    Component(Component),
    Compound(&'a [FormatItem<'a>]),
    Optional(&'a FormatItem<'a>),
    First(&'a [FormatItem<'a>]),
}
Available on crate feature cookies only.
Expand description

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

Variants (Non-exhaustive)§

This enum is marked as 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: If you call the format method that returns a String, these bytes will be passed through String::from_utf8_lossy.

§

Component(Component)

A minimal representation of a single non-literal item.

§

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

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

§

Optional(&'a FormatItem<'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 [FormatItem<'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§

source§

impl<'a> Clone for FormatItem<'a>

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for FormatItem<'_>

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Converts to this type from the input type.
source§

impl From<Component> for FormatItem<'_>

source§

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

Converts to this type from the input type.
source§

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

source§

fn eq(&self, rhs: &&[FormatItem<'_>]) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<Component> for FormatItem<'_>

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

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

source§

fn eq(&self, rhs: &FormatItem<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl PartialEq<FormatItem<'_>> for Component

source§

fn eq(&self, rhs: &FormatItem<'_>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<'a> PartialEq<FormatItem<'a>> for FormatItem<'a>

source§

fn eq(&self, other: &FormatItem<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl TryFrom<FormatItem<'_>> for Component

§

type Error = DifferentVariant

The type returned in the event of a conversion error.
source§

fn try_from( value: FormatItem<'_> ) -> Result<Component, <Component as TryFrom<FormatItem<'_>>>::Error>

Performs the conversion.
source§

impl<'a> TryFrom<FormatItem<'a>> for &[FormatItem<'a>]

§

type Error = DifferentVariant

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

impl<'a> Eq for FormatItem<'a>

source§

impl Formattable for FormatItem<'_>

source§

impl Parsable for FormatItem<'_>

source§

impl<'a> StructuralEq for FormatItem<'a>

source§

impl<'a> StructuralPartialEq for FormatItem<'a>

Auto Trait Implementations§

§

impl<'a> RefUnwindSafe for FormatItem<'a>

§

impl<'a> Send for FormatItem<'a>

§

impl<'a> Sync for FormatItem<'a>

§

impl<'a> Unpin for FormatItem<'a>

§

impl<'a> UnwindSafe for FormatItem<'a>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

const: unstable · source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more