Struct PatternString

pub struct PatternString<B: PatternBackend>(pub Box<Pattern<B>>);

Tuple Fields

0: Box<Pattern<B>>

Methods from Deref<Target = Pattern<B>>

pub fn iter( &self, ) -> impl Iterator<Item = PatternItem<'_, B::PlaceholderKey<'_>>> + '_

Returns an iterator over the PatternItems in this pattern.

pub fn try_interpolate<'a, P>( &'a self, value_provider: P, ) -> impl TryWriteable<Error = B::Error<'a>> + Display + 'a

where P: PlaceholderValueProvider<B::PlaceholderKey<'a>, Error = B::Error<'a>> + 'a,

Returns a TryWriteable that interpolates items from the given replacement provider into this pattern string.

pub fn try_interpolate_to_string<'a, P>( &'a self, value_provider: P, ) -> Result<String, (B::Error<'a>, String)>

where P: PlaceholderValueProvider<B::PlaceholderKey<'a>, Error = B::Error<'a>> + 'a,

Interpolates the pattern directly to a string, returning the string or an error.

In addition to the error, the lossy fallback string is returned in the failure case.

✨ Enabled with the alloc Cargo feature.

pub fn interpolate<'a, P>( &'a self, value_provider: P, ) -> impl Writeable + Display + 'a

where P: PlaceholderValueProvider<B::PlaceholderKey<'a>, Error = B::Error<'a>> + 'a,

Returns a Writeable that interpolates items from the given replacement provider into this pattern string.

pub fn interpolate_to_string<'a, P>(&'a self, value_provider: P) -> String

where P: PlaceholderValueProvider<B::PlaceholderKey<'a>, Error = B::Error<'a>> + 'a,

Interpolates the pattern directly to a string.

✨ Enabled with the alloc Cargo feature.

Trait Implementations

impl<B: PatternBackend> Clone for PatternString<B>

where Box<B::Store>: for<'a> From<&'a B::Store>,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B: Debug + PatternBackend> Debug for PatternString<B>

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

Formats the value using the given formatter.

impl<B: PatternBackend> Default for PatternString<B>

where Box<B::Store>: for<'a> From<&'a B::Store>,

fn default() -> Self

Returns the “default value” for a type.

impl<B: PatternBackend> Deref for PatternString<B>

type Target = Pattern<B>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de, B: PatternBackend> Deserialize<'de> for PatternString<B>

where B::PlaceholderKeyCow<'de>: FromStr, <B::PlaceholderKeyCow<'de> as FromStr>::Err: Debug,

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<B: PartialEq + PatternBackend> PartialEq for PatternString<B>

fn eq(&self, other: &PatternString<B>) -> 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<B: PatternBackend> StructuralPartialEq for PatternString<B>