Struct fluent_bundle::FluentArgs

source ·
pub struct FluentArgs<'args>(/* private fields */);
Expand description

Fluent messages can use arguments in order to programmatically add values to a translated string. For instance, in a localized application you may wish to display a user’s email count. This could be done with the following message.

msg-key = Hello, { $user }. You have { $emailCount } messages.

Here $user and $emailCount are the arguments, which can be filled with values.

The FluentArgs struct is the map from the argument name (for example $user) to the argument value (for example “John”.) The logic to apply these to write these to messages is elsewhere, this struct just stores the value.

§Example

use fluent_bundle::{FluentArgs, FluentBundle, FluentResource};

let mut args = FluentArgs::new();
args.set("user", "John");
args.set("emailCount", 5);

let res = FluentResource::try_new(r#"

msg-key = Hello, { $user }. You have { $emailCount } messages.

"#.to_string())
    .expect("Failed to parse FTL.");

let mut bundle = FluentBundle::default();

// For this example, we'll turn on BiDi support.
// Please, be careful when doing it, it's a risky move.
bundle.set_use_isolating(false);

bundle.add_resource(res)
    .expect("Failed to add a resource.");

let mut err = vec![];

let msg = bundle.get_message("msg-key")
    .expect("Failed to retrieve a message.");
let value = msg.value()
    .expect("Failed to retrieve a value.");

assert_eq!(
    bundle.format_pattern(value, Some(&args), &mut err),
    "Hello, John. You have 5 messages."
);

Implementations§

source§

impl<'args> FluentArgs<'args>

source

pub fn new() -> Self

Creates a new empty argument map.

source

pub fn with_capacity(capacity: usize) -> Self

Pre-allocates capacity for arguments.

source

pub fn get<K>(&self, key: K) -> Option<&FluentValue<'args>>
where K: Into<Cow<'args, str>>,

Gets the FluentValue at the key if it exists.

source

pub fn set<K, V>(&mut self, key: K, value: V)
where K: Into<Cow<'args, str>>, V: Into<FluentValue<'args>>,

Sets the key value pair.

source

pub fn iter(&self) -> impl Iterator<Item = (&str, &FluentValue<'_>)>

Iterate over a tuple of the key an FluentValue.

Trait Implementations§

source§

impl<'args> Debug for FluentArgs<'args>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'args> Default for FluentArgs<'args>

source§

fn default() -> FluentArgs<'args>

Returns the “default value” for a type. Read more
source§

impl<'args, K, V> FromIterator<(K, V)> for FluentArgs<'args>
where K: Into<Cow<'args, str>>, V: Into<FluentValue<'args>>,

source§

fn from_iter<I>(iter: I) -> Self
where I: IntoIterator<Item = (K, V)>,

Creates a value from an iterator. Read more
source§

impl<'args> IntoIterator for FluentArgs<'args>

§

type Item = (Cow<'args, str>, FluentValue<'args>)

The type of the elements being iterated over.
§

type IntoIter = IntoIter<<FluentArgs<'args> as IntoIterator>::Item>

Which kind of iterator are we turning this into?
source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more

Auto Trait Implementations§

§

impl<'args> Freeze for FluentArgs<'args>

§

impl<'args> !RefUnwindSafe for FluentArgs<'args>

§

impl<'args> Send for FluentArgs<'args>

§

impl<'args> !Sync for FluentArgs<'args>

§

impl<'args> Unpin for FluentArgs<'args>

§

impl<'args> !UnwindSafe for FluentArgs<'args>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.