Struct icu_experimental::dimension::currency::formatter::CurrencyFormatter
source · pub struct CurrencyFormatter { /* private fields */ }
Expand description
A formatter for monetary values.
CurrencyFormatter
supports:
- Rendering in the locale’s currency system.
- Locale-sensitive grouping separator positions.
Read more about the options in the super::options
module.
Implementations§
source§impl CurrencyFormatter
impl CurrencyFormatter
sourcepub fn try_new_with_any_provider(
provider: &(impl AnyProvider + ?Sized),
prefs: CurrencyFormatterPreferences,
options: CurrencyFormatterOptions,
) -> Result<Self, DataError>
pub fn try_new_with_any_provider( provider: &(impl AnyProvider + ?Sized), prefs: CurrencyFormatterPreferences, options: CurrencyFormatterOptions, ) -> Result<Self, DataError>
A version of [Self :: try_new
] that uses custom data provided by an AnyProvider
.
sourcepub fn try_new_with_buffer_provider(
provider: &(impl BufferProvider + ?Sized),
prefs: CurrencyFormatterPreferences,
options: CurrencyFormatterOptions,
) -> Result<Self, DataError>
pub fn try_new_with_buffer_provider( provider: &(impl BufferProvider + ?Sized), prefs: CurrencyFormatterPreferences, options: CurrencyFormatterOptions, ) -> Result<Self, DataError>
A version of [Self :: try_new
] that uses custom data provided by a BufferProvider
.
✨ Enabled with the serde
feature.
sourcepub fn try_new(
prefs: CurrencyFormatterPreferences,
options: CurrencyFormatterOptions,
) -> Result<Self, DataError>
pub fn try_new( prefs: CurrencyFormatterPreferences, options: CurrencyFormatterOptions, ) -> Result<Self, DataError>
Creates a new CurrencyFormatter
from compiled locale data and an options bag.
✨ Enabled with the compiled_data
Cargo feature.
sourcepub fn try_new_unstable<D>(
provider: &D,
prefs: CurrencyFormatterPreferences,
options: CurrencyFormatterOptions,
) -> Result<Self, DataError>where
D: ?Sized + DataProvider<CurrencyEssentialsV1Marker> + DataProvider<DecimalSymbolsV2Marker> + DataProvider<DecimalDigitsV1Marker>,
pub fn try_new_unstable<D>(
provider: &D,
prefs: CurrencyFormatterPreferences,
options: CurrencyFormatterOptions,
) -> Result<Self, DataError>where
D: ?Sized + DataProvider<CurrencyEssentialsV1Marker> + DataProvider<DecimalSymbolsV2Marker> + DataProvider<DecimalDigitsV1Marker>,
A version of Self::try_new
that uses custom data provided by a DataProvider
.
⚠️ The bounds on provider may change over time, including in SemVer minor releases.
sourcepub fn format_fixed_decimal<'l>(
&'l self,
value: &'l SignedFixedDecimal,
currency_code: CurrencyCode,
) -> FormattedCurrency<'l>
pub fn format_fixed_decimal<'l>( &'l self, value: &'l SignedFixedDecimal, currency_code: CurrencyCode, ) -> FormattedCurrency<'l>
Formats a [SignedFixedDecimal
] value for the given currency code.
§Examples
use icu::experimental::dimension::currency::formatter::CurrencyFormatter;
use icu::experimental::dimension::currency::CurrencyCode;
use icu::locale::locale;
use tinystr::*;
use writeable::Writeable;
let locale = locale!("en-US").into();
let fmt = CurrencyFormatter::try_new(locale, Default::default()).unwrap();
let value = "12345.67".parse().unwrap();
let currency_code = CurrencyCode(tinystr!(3, "USD"));
let formatted_currency = fmt.format_fixed_decimal(&value, currency_code);
let mut sink = String::new();
formatted_currency.write_to(&mut sink).unwrap();
assert_eq!(sink.as_str(), "$12,345.67");
Auto Trait Implementations§
impl Freeze for CurrencyFormatter
impl RefUnwindSafe for CurrencyFormatter
impl Send for CurrencyFormatter
impl Sync for CurrencyFormatter
impl Unpin for CurrencyFormatter
impl UnwindSafe for CurrencyFormatter
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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