Struct icu_list::ListFormatter

pub struct ListFormatter { /* private fields */ }

A formatter that renders sequences of items in an i18n-friendly way. See the crate-level documentation for more details.

Implementations

impl ListFormatter

pub fn try_new_and( prefs: ListFormatterPreferences, options: ListFormatterOptions, ) -> Result<Self, 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.

📚 Help choosing a constructor

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

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

📚 Help choosing a constructor

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

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

✨ Enabled with the serde feature.

📚 Help choosing a constructor

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

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

📚 Help choosing a constructor

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

pub fn try_new_or( prefs: ListFormatterPreferences, options: ListFormatterOptions, ) -> Result<Self, 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.

📚 Help choosing a constructor

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

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

📚 Help choosing a constructor

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

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

✨ Enabled with the serde feature.

📚 Help choosing a constructor

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

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

📚 Help choosing a constructor

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

pub fn try_new_unit( prefs: ListFormatterPreferences, options: ListFormatterOptions, ) -> Result<Self, 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.

📚 Help choosing a constructor

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

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

📚 Help choosing a constructor

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

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

✨ Enabled with the serde feature.

📚 Help choosing a constructor

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

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

📚 Help choosing a constructor

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

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

Returns a [Writeable] composed of the input [Writeable]s 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: Writeable, I: Iterator<Item = W> + Clone>( &self, values: I, ) -> String

Returns a String composed of the input [Writeable]s and the language-dependent formatting.

Trait Implementations

impl Debug for ListFormatter

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

Formats the value using the given formatter.