Enum simplelog::FormatItem

#[non_exhaustive]
pub enum FormatItem<'a> {
    Literal(&'a [u8]),
    Component(Component),
    Compound(&'a [FormatItem<'a>]),
    Optional(&'a FormatItem<'a>),
    First(&'a [FormatItem<'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: 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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'_> Debug for FormatItem<'_>

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

Formats the value using the given formatter.

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

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

Converts to this type from the input type.

impl<'_> From<Component> for FormatItem<'_>

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

Converts to this type from the input type.

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

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

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

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

This method tests for !=.

impl<'_> PartialEq<Component> for FormatItem<'_>

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

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

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

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

This method tests for !=.

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

type Error = DifferentVariant

The type returned in the event of a conversion error.

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

Performs the conversion.

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

impl<'_> Formattable for FormatItem<'_>

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

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