Struct rustc_errors::translation::FluentArgs

pub struct FluentArgs<'args>(Vec<(Cow<'args, str>, FluentValue<'args>)>);

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."
);

Tuple Fields

0: Vec<(Cow<'args, str>, FluentValue<'args>)>

Implementations

impl<'args> FluentArgs<'args>

pub fn new() -> FluentArgs<'args>

Creates a new empty argument map.

pub fn with_capacity(capacity: usize) -> FluentArgs<'args>

Pre-allocates capacity for arguments.

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.

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.

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

Iterate over a tuple of the key an FluentValue.

Trait Implementations

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

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

Formats the value using the given formatter.

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

fn default() -> FluentArgs<'args>

Returns the “default value” for a type.

impl<'args, K, V> FromIterator<(K, V)> for FluentArgs<'args>

where K: Into<Cow<'args, str>>, V: Into<FluentValue<'args>>,

fn from_iter<I>(iter: I) -> FluentArgs<'args>

where I: IntoIterator<Item = (K, V)>,

Creates a value from an iterator.

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

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

The type of the elements being iterated over.

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

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<(Cow<'args, str>, FluentValue<'args>)>

Creates an iterator from a value.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 24 bytes