Struct icu :: list :: ListFormatter Copy item path

impl ListFormatter

pub fn try_new_and( prefs: ListFormatterPreferences, options: ListFormatterOptions, ) -> Result<ListFormatter, DataError>

Creates a new ListFormatter that produces a and-type list using compiled data.

See the CLDR spec for an explanation of the different types.

✨ Enabled with the compiled_data Cargo feature.

pub fn try_new_and_with_any_provider( provider: &(impl AnyProvider + ?Sized), prefs: ListFormatterPreferences, options: ListFormatterOptions, ) -> Result<ListFormatter, DataError>

A version of [Self :: try_new_and] that uses custom data provided by an AnyProvider.

pub fn try_new_and_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), prefs: ListFormatterPreferences, options: ListFormatterOptions, ) -> Result<ListFormatter, DataError>

A version of [Self :: try_new_and] that uses custom data provided by a BufferProvider.

✨ Enabled with the serde feature.

pub fn try_new_and_unstable( provider: &(impl DataProvider<AndListV2Marker> + ?Sized), prefs: ListFormatterPreferences, options: ListFormatterOptions, ) -> Result<ListFormatter, DataError>

A version of [Self :: try_new_and] that uses custom data provided by a DataProvider.

⚠️ The bounds on provider may change over time, including in SemVer minor releases.

pub fn try_new_or( prefs: ListFormatterPreferences, options: ListFormatterOptions, ) -> Result<ListFormatter, DataError>

Creates a new ListFormatter that produces a or-type list using compiled data.

See the CLDR spec for an explanation of the different types.

✨ Enabled with the compiled_data Cargo feature.

pub fn try_new_or_with_any_provider( provider: &(impl AnyProvider + ?Sized), prefs: ListFormatterPreferences, options: ListFormatterOptions, ) -> Result<ListFormatter, DataError>

A version of [Self :: try_new_or] that uses custom data provided by an AnyProvider.

pub fn try_new_or_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), prefs: ListFormatterPreferences, options: ListFormatterOptions, ) -> Result<ListFormatter, DataError>

A version of [Self :: try_new_or] that uses custom data provided by a BufferProvider.

✨ Enabled with the serde feature.

pub fn try_new_or_unstable( provider: &(impl DataProvider<OrListV2Marker> + ?Sized), prefs: ListFormatterPreferences, options: ListFormatterOptions, ) -> Result<ListFormatter, DataError>

A version of [Self :: try_new_or] that uses custom data provided by a DataProvider.

⚠️ The bounds on provider may change over time, including in SemVer minor releases.

pub fn try_new_unit( prefs: ListFormatterPreferences, options: ListFormatterOptions, ) -> Result<ListFormatter, DataError>

Creates a new ListFormatter that produces a unit-type list using compiled data.

See the CLDR spec for an explanation of the different types.

✨ Enabled with the compiled_data Cargo feature.

pub fn try_new_unit_with_any_provider( provider: &(impl AnyProvider + ?Sized), prefs: ListFormatterPreferences, options: ListFormatterOptions, ) -> Result<ListFormatter, DataError>

A version of [Self :: try_new_unit] that uses custom data provided by an AnyProvider.

pub fn try_new_unit_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), prefs: ListFormatterPreferences, options: ListFormatterOptions, ) -> Result<ListFormatter, DataError>

A version of [Self :: try_new_unit] that uses custom data provided by a BufferProvider.

✨ Enabled with the serde feature.

pub fn try_new_unit_unstable( provider: &(impl DataProvider<UnitListV2Marker> + ?Sized), prefs: ListFormatterPreferences, options: ListFormatterOptions, ) -> Result<ListFormatter, DataError>

A version of [Self :: try_new_unit] that uses custom data provided by a DataProvider.

⚠️ The bounds on provider may change over time, including in SemVer minor releases.

pub fn format<'a, W, I>(&'a self, values: I) -> FormattedList<'a, W, I>
where W: Writeable + 'a, I: Iterator<Item = W> + Clone + 'a,

Returns a Writeable composed of the input Writeables and the language-dependent formatting.

The Writeable is annotated with parts::ELEMENT for input elements, and parts::LITERAL for list literals.

§Example

use icu::list::*;
let formatteur = ListFormatter::try_new_and(
    locale!("fr").into(),
    ListFormatterOptions::default()
        .with_length(ListLength::Wide)
)
.unwrap();
let pays = ["Italie", "France", "Espagne", "Allemagne"];

assert_writeable_parts_eq!(
    formatteur.format(pays.iter()),
    "Italie, France, Espagne et Allemagne",
    [
        (0, 6, parts::ELEMENT),
        (6, 8, parts::LITERAL),
        (8, 14, parts::ELEMENT),
        (14, 16, parts::LITERAL),
        (16, 23, parts::ELEMENT),
        (23, 27, parts::LITERAL),
        (27, 36, parts::ELEMENT),
    ]
);

pub fn format_to_string<W, I>(&self, values: I) -> String
where W: Writeable, I: Iterator<Item = W> + Clone,

Returns a String composed of the input Writeables and the language-dependent formatting.

Trait Implementations§

impl Debug for ListFormatter

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for ListFormatter

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> ErasedDestructor for T
where T: 'static,