Struct Pattern

pub struct Pattern<'data> {
    pub items: ZeroVec<'data, PatternItem>,
    pub metadata: PatternMetadata,
}

A raw, low-level pattern for datetime formatting.

It consists of an owned-or-borrowed list of PatternItems corresponding to either fields or literal characters.

🚧 This code is considered unstable; it may change at any time, in breaking or non-breaking ways, including in SemVer minor releases. While the serde representation of data structs is guaranteed to be stable, their Rust representation might not be. Use with caution.

Fields

items: ZeroVec<'data, PatternItem>

The list of PatternItems.

metadata: PatternMetadata

Pre-computed metadata about the pattern.

This field should contain the smallest time unit from the items vec. If it doesn’t, unexpected results for day periods may be encountered.

Implementations

impl Pattern<'_>

pub fn to_string(&self) -> String

Converts the given value to a String.

Under the hood, this uses an efficient Writeable implementation. However, in order to avoid allocating a string, it is more efficient to use Writeable directly.

impl Pattern<'_>

pub fn as_ref(&self) -> Pattern<'_>

Borrows a Pattern from another Pattern.

Trait Implementations

impl<'data> Clone for Pattern<'data>

fn clone(&self) -> Pattern<'data>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'data> Debug for Pattern<'data>

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

Formats the value using the given formatter.

impl Default for Pattern<'_>

fn default() -> Self

Returns the “default value” for a type.

impl<'de: 'data, 'data> Deserialize<'de> for Pattern<'data>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Pattern<'_>

This trait is implemented for compatibility with fmt!. To create a string, Writeable::write_to_string is usually more efficient.

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

Formats the value using the given formatter.

impl<'data> EncodeAsVarULE<PatternULE> for &Pattern<'data>

fn encode_var_ule_as_slices<R>(&self, cb: impl FnOnce(&[&[u8]]) -> R) -> R

Calls cb with a piecewise list of byte slices that when concatenated produce the memory pattern of the corresponding instance of T.

fn encode_var_ule_len(&self) -> usize

Return the length, in bytes, of the corresponding VarULE type

fn encode_var_ule_write(&self, dst: &mut [u8])

Write the corresponding VarULE type to the dst buffer. dst should be the size of Self::encode_var_ule_len()

impl<'data> EncodeAsVarULE<PatternULE> for Pattern<'data>

fn encode_var_ule_as_slices<R>(&self, cb: impl FnOnce(&[&[u8]]) -> R) -> R

Calls cb with a piecewise list of byte slices that when concatenated produce the memory pattern of the corresponding instance of T.

fn encode_var_ule_len(&self) -> usize

Return the length, in bytes, of the corresponding VarULE type

fn encode_var_ule_write(&self, dst: &mut [u8])

Write the corresponding VarULE type to the dst buffer. dst should be the size of Self::encode_var_ule_len()

impl From<&Pattern<'_>> for Pattern

fn from(input: &Pattern<'_>) -> Self

Converts to this type from the input type.

impl From<&Pattern> for Pattern<'_>

fn from(input: &Pattern) -> Self

Converts to this type from the input type.

impl<'data> From<&'data PatternULE> for Pattern<'data>

fn from(other: &'data PatternULE) -> Self

Converts to this type from the input type.

impl From<DateTimePattern> for Pattern<'_>

fn from(value: DateTimePattern) -> Self

Converts to this type from the input type.

impl<'a> From<Pattern<'a>> for DateTimePattern

fn from(pattern: Pattern<'a>) -> Self

Converts to this type from the input type.

impl From<Vec<PatternItem>> for Pattern<'_>

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

Converts to this type from the input type.

impl FromIterator<PatternItem> for Pattern<'_>

fn from_iter<T: IntoIterator<Item = PatternItem>>(iter: T) -> Self

Creates a value from an iterator.

impl FromStr for Pattern<'_>

type Err = PatternError

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl<'data> PartialEq for Pattern<'data>

fn eq(&self, other: &Pattern<'data>) -> 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 Writeable for Pattern<'_>

This trait is implemented in order to provide the machinery to convert a Pattern to a UTS 35 pattern string.

fn write_to<W: Write + ?Sized>(&self, formatter: &mut W) -> Result

Writes a string to the given sink. Errors from the sink are bubbled up. The default implementation delegates to write_to_parts, and discards any Part annotations.

fn write_to_parts<S>(&self, sink: &mut S) -> Result<(), Error>

where S: PartsWrite + ?Sized,

Write bytes and Part annotations to the given sink. Errors from the sink are bubbled up. The default implementation delegates to write_to, and doesn’t produce any Part annotations.

fn writeable_length_hint(&self) -> LengthHint

Returns a hint for the number of UTF-8 bytes that will be written to the sink.

fn write_to_string(&self) -> Cow<'_, str>

Creates a new String with the data from this Writeable. Like ToString, but smaller and faster.

impl<'a> Yokeable<'a> for Pattern<'static>

type Output = Pattern<'a>

This type MUST be Self with the 'static replaced with 'a, i.e. Self<'a>

fn transform(&'a self) -> &'a Self::Output

This method must cast self between &'a Self<'static> and &'a Self<'a>.

fn transform_owned(self) -> Self::Output

This method must cast self between Self<'static> and Self<'a>.

unsafe fn make(this: Self::Output) -> Self

This method can be used to cast away Self<'a>’s lifetime.

fn transform_mut<F>(&'a mut self, f: F)

where F: 'static + for<'b> FnOnce(&'b mut Self::Output),

This method must cast self between &'a mut Self<'static> and &'a mut Self<'a>, and pass it to f.

impl<'data> ZeroFrom<'data, PatternULE> for Pattern<'data>

fn zero_from(other: &'data PatternULE) -> Self

Clone the other C into a struct that may retain references into C.

impl<'zf, 'zf_inner> ZeroFrom<'zf, Pattern<'zf_inner>> for Pattern<'zf>

fn zero_from(this: &'zf Pattern<'zf_inner>) -> Self

Clone the other C into a struct that may retain references into C.

impl<'data> Eq for Pattern<'data>

impl<'data> StructuralPartialEq for Pattern<'data>