rustc_errors::translation

Struct FluentArgs

Source
pub struct FluentArgs<'args>(Vec<(Cow<'args, str>, FluentValue<'args>)>);
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."
);

Tuple Fields§

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

Implementations§

Source§

impl<'args> FluentArgs<'args>

Source

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

Creates a new empty argument map.

Source

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

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<(), Error>

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) -> FluentArgs<'args>
where I: IntoIterator<Item = (K, V)>,

Creates a value from an iterator. Read more
Source§

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

Source§

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

The type of the elements being iterated over.
Source§

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

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

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

Creates an iterator from a value. Read more

Auto Trait Implementations§

§

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

§

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

§

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> Aligned for T

Source§

const ALIGN: Alignment = _

Alignment of Self.
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, R> CollectAndApply<T, R> for T

Source§

fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to f(&iter.collect::<Vec<_>>()).

Source§

type Output = R

Source§

impl<T> Filterable for T

Source§

fn filterable( self, filter_name: &'static str, ) -> RequestFilterDataProvider<T, fn(_: DataRequest<'_>) -> bool>

Creates a filterable data provider with the given name for debugging. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

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
Source§

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
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize = _

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

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>,

Source§

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.
Source§

impl<I, T, U> Upcast<I, U> for T
where U: UpcastFrom<I, T>,

Source§

fn upcast(self, interner: I) -> U

Source§

impl<I, T> UpcastFrom<I, T> for T

Source§

fn upcast_from(from: T, _tcx: I) -> T

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<'a, T> Captures<'a> for T
where T: ?Sized,

Source§

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

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