Struct icu::pattern::Pattern

#[repr(transparent)]
pub struct Pattern<B>
where
    B: PatternBackend,
{
    pub store: <B as PatternBackend>::Store,
    /* private fields */
}

A string pattern with placeholders.

There are 2 generic parameters: Backend and Store.

Backend

This determines the nature of placeholders and serialized encoding of the pattern.

The following backends are available:

• SinglePlaceholder for patterns with up to one placeholder: "{0} days ago"
• DoublePlaceholder for patterns with up to two placeholders: "{0} days, {1} hours ago"
• MultiNamedPlaceholder for patterns with named placeholders: "{name} sent you a message"

Format to Parts

Pattern supports interpolating with writeable::Parts, annotations for whether the substring was a placeholder or a literal.

By default, the substrings are annotated with PATTERN_LITERAL_PART and PATTERN_PLACEHOLDER_PART. This can be customized with PlaceholderValueProvider.

Examples

Interpolating a SinglePlaceholder pattern with parts:

use core::str::FromStr;
use icu_pattern::Pattern;
use icu_pattern::SinglePlaceholder;
use writeable::assert_writeable_parts_eq;

let pattern =
    Pattern::<SinglePlaceholder>::try_from_str("Hello, {0}!", Default::default()).unwrap();

assert_writeable_parts_eq!(
    pattern.interpolate(["Alice"]),
    "Hello, Alice!",
    [
        (0, 7, icu_pattern::PATTERN_LITERAL_PART),
        (7, 12, icu_pattern::PATTERN_PLACEHOLDER_PART),
        (12, 13, icu_pattern::PATTERN_LITERAL_PART),
    ]
);

Fields

store: <B as PatternBackend>::Store

The encoded storage

Implementations

impl<B> Pattern<B>

where B: PatternBackend,

pub fn try_from_items<'a, I>(items: I) -> Result<Box<Pattern<B>>, PatternError>

where I: Iterator<Item = PatternItemCow<'a, <B as PatternBackend>::PlaceholderKeyCow<'a>>>,

Creates a pattern from an iterator of pattern items.

✨ Enabled with the alloc Cargo feature.

Examples

use icu_pattern::Pattern;
use icu_pattern::PatternItemCow;
use icu_pattern::SinglePlaceholder;
use icu_pattern::SinglePlaceholderKey;
use std::borrow::Cow;

Pattern::<SinglePlaceholder>::try_from_items(
    [
        PatternItemCow::Placeholder(SinglePlaceholderKey::Singleton),
        PatternItemCow::Literal(Cow::Borrowed(" days")),
    ]
    .into_iter(),
)
.expect("valid pattern items");

impl<'a, B> Pattern<B>

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

pub fn try_from_str( pattern: &str, options: ParserOptions, ) -> Result<Box<Pattern<B>>, PatternError>

Creates a pattern by parsing a syntax string.

✨ Enabled with the alloc Cargo feature.

Examples

use icu_pattern::Pattern;
use icu_pattern::SinglePlaceholder;

// Create a pattern from a valid string:
Pattern::<SinglePlaceholder>::try_from_str("{0} days", Default::default())
    .expect("valid pattern");

// Error on an invalid pattern:
Pattern::<SinglePlaceholder>::try_from_str("{0 days", Default::default())
    .expect_err("mismatched braces");

impl<B> Pattern<B>

where B: PatternBackend,

pub fn iter( &self, ) -> impl Iterator<Item = PatternItem<'_, <B as PatternBackend>::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 as PatternBackend>::Error<'a>> + Display + 'a

where P: PlaceholderValueProvider<<B as PatternBackend>::PlaceholderKey<'a>, Error = <B as PatternBackend>::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 as PatternBackend>::Error<'a>, String)>

where P: PlaceholderValueProvider<<B as PatternBackend>::PlaceholderKey<'a>, Error = <B as PatternBackend>::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.

impl<B> Pattern<B>

where B: for<'b> PatternBackend<Error<'b> = Infallible>,

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

where P: PlaceholderValueProvider<<B as PatternBackend>::PlaceholderKey<'a>, Error = <B as PatternBackend>::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 as PatternBackend>::PlaceholderKey<'a>, Error = <B as PatternBackend>::Error<'a>> + 'a,

Interpolates the pattern directly to a string.

✨ Enabled with the alloc Cargo feature.

Trait Implementations

impl<B> Bake for &Pattern<B>

where B: PatternBackend, &'b <B as PatternBackend>::Store: for<'b> Bake,

fn bake(&self, ctx: &CrateEnv) -> TokenStream

Returns a TokenStream that would evaluate to self.

impl<B> BakeSize for &Pattern<B>

where B: PatternBackend, &'b <B as PatternBackend>::Store: for<'b> BakeSize,

fn borrows_size(&self) -> usize

Returns the size

impl<B> Clone for Box<Pattern<B>>

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

fn clone(&self) -> Box<Pattern<B>>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B> Debug for Pattern<B>

where B: PatternBackend,

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

Formats the value using the given formatter.

impl<B> Default for &'static Pattern<B>

where B: PatternBackend,

fn default() -> &'static Pattern<B>

Returns the “default value” for a type.

impl<B> Default for Box<Pattern<B>>

where B: PatternBackend, Box<<B as PatternBackend>::Store>: From<&'static <B as PatternBackend>::Store>,

fn default() -> Box<Pattern<B>>

Returns the “default value” for a type.

impl<'de, 'data, B> Deserialize<'de> for &'data Pattern<B>

where 'de: 'data, B: PatternBackend, &'data <B as PatternBackend>::Store: Deserialize<'de>,

fn deserialize<D>( deserializer: D, ) -> Result<&'data Pattern<B>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'de, 'data, B> Deserialize<'de> for Box<Pattern<B>>

where 'de: 'data, B: PatternBackend<Store = str>, <B as PatternBackend>::PlaceholderKeyCow<'data>: Deserialize<'de>,

fn deserialize<D>( deserializer: D, ) -> Result<Box<Pattern<B>>, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<B> PartialEq for Pattern<B>

where B: PatternBackend,

fn eq(&self, other: &Pattern<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> Serialize for Pattern<B>

where B: PatternBackend, <B as PatternBackend>::Store: Serialize, <B as PatternBackend>::PlaceholderKeyCow<'a>: for<'a> Serialize + for<'a> From<<B as PatternBackend>::PlaceholderKey<'a>>,

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<B> ToOwned for Pattern<B>

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

type Owned = Box<Pattern<B>>

The resulting type after obtaining ownership.

fn to_owned(&self) -> <Pattern<B> as ToOwned>::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl<B, S> VarULE for Pattern<B>

where S: VarULE + ?Sized, B: PatternBackend<Store = S>,

Implement VarULE for Pattern<SinglePlaceholder, str>.

Safety

Safety checklist for ULE:

1. Pattern<B> does not include any uninitialized or padding bytes.
2. Pattern<B> is aligned to 1 byte.
3. The implementation of validate_byte_slice() returns an error if any byte is not valid.
4. The implementation of validate_byte_slice() returns an error if the slice cannot be used to build a Pattern<B> in its entirety.
5. The implementation of from_byte_slice_unchecked() returns a reference to the same data.
6. parse_byte_slice() is equivalent to validate_byte_slice() followed by from_byte_slice_unchecked().
7. Pattern<B> byte equality is semantic equality.

fn validate_byte_slice(bytes: &[u8]) -> Result<(), UleError>

Validates a byte slice, &[u8].

unsafe fn from_byte_slice_unchecked(bytes: &[u8]) -> &Pattern<B>

Takes a byte slice, &[u8], and return it as &Self with the same lifetime, assuming that this byte slice has previously been run through Self::parse_byte_slice() with success.

fn parse_byte_slice(bytes: &[u8]) -> Result<&Self, UleError>

Parses a byte slice, &[u8], and return it as &Self with the same lifetime.

fn as_byte_slice(&self) -> &[u8]

Given &Self, returns a &[u8] with the same lifetime.

fn to_boxed(&self) -> Box<Self>

Allocate on the heap as a Box<T>

impl<'a, B> Yokeable<'a> for Pattern<B>

where B: PatternBackend + 'static, Pattern<B>: Sized,

type Output = Pattern<B>

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

fn transform(&self) -> &<Pattern<B> as Yokeable<'a>>::Output

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

fn transform_owned(self) -> <Pattern<B> as Yokeable<'a>>::Output

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

unsafe fn make(this: <Pattern<B> as Yokeable<'a>>::Output) -> Pattern<B>

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 <Pattern<B> as Yokeable<'a>>::Output),

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

impl<'a, B> ZeroMapKV<'a> for Pattern<B>

where B: PatternBackend, Pattern<B>: VarULE,

type Container = VarZeroVec<'a, Pattern<B>>

The container that can be used with this type: ZeroVec or VarZeroVec.

type Slice = VarZeroSlice<Pattern<B>>

type GetType = Pattern<B>

The type produced by Container::get()

type OwnedType = Box<Pattern<B>>

The type produced by Container::replace() and Container::remove(), also used during deserialization. If Self is human readable serialized, deserializing to Self::OwnedType should produce the same value once passed through Self::owned_as_self()