Enum FluentValue

pub enum FluentValue<'source> {
    String(Cow<'source, str>),
    Number(FluentNumber),
    Custom(Box<dyn FluentType + Send>),
    None,
    Error,
}

The FluentValue enum represents values which can be formatted to a String.

Those values are either passed as arguments to FluentBundle::format_pattern or produced by functions, or generated in the process of pattern resolution.

Variants

String(Cow<'source, str>)

Number(FluentNumber)

Custom(Box<dyn FluentType + Send>)

None

Error

Implementations

impl<'source> FluentValue<'source>

pub fn try_number(value: &'source str) -> Self

Attempts to parse the string representation of a value that supports ToString into a FluentValue::Number. If it fails, it will instead convert it to a FluentValue::String.

use fluent_bundle::types::{FluentNumber, FluentNumberOptions, FluentValue};

// "2" parses into a `FluentNumber`
assert_eq!(
    FluentValue::try_number("2"),
    FluentValue::Number(FluentNumber::new(2.0, FluentNumberOptions::default()))
);

// Floats can be parsed as well.
assert_eq!(
    FluentValue::try_number("3.141569"),
    FluentValue::Number(FluentNumber::new(
        3.141569,
        FluentNumberOptions {
            minimum_fraction_digits: Some(6),
            ..Default::default()
        }
    ))
);

// When a value is not a valid number, it falls back to a `FluentValue::String`
assert_eq!(
    FluentValue::try_number("A string"),
    FluentValue::String("A string".into())
);

pub fn matches<R: Borrow<FluentResource>, M>( &self, other: &FluentValue<'_>, scope: &Scope<'_, '_, '_, '_, R, M>, ) -> bool

where M: MemoizerKind,

Checks to see if two FluentValues match each other by having the same type and contents. The special exception is in the case of a string being compared to a number. Here attempt to check that the plural rule category matches.

use fluent_bundle::resolver::Scope;
use fluent_bundle::{types::FluentValue, FluentBundle, FluentResource};
use unic_langid::langid;

let langid_ars = langid!("en");
let bundle: FluentBundle<FluentResource> = FluentBundle::new(vec![langid_ars]);
let scope = Scope::new(&bundle, None, None);

// Matching examples:
assert!(FluentValue::try_number("2").matches(&FluentValue::try_number("2"), &scope));
assert!(FluentValue::from("fluent").matches(&FluentValue::from("fluent"), &scope));
assert!(
    FluentValue::from("one").matches(&FluentValue::try_number("1"), &scope),
    "Plural rules are matched."
);

// Non-matching examples:
assert!(!FluentValue::try_number("2").matches(&FluentValue::try_number("3"), &scope));
assert!(!FluentValue::from("fluent").matches(&FluentValue::from("not fluent"), &scope));
assert!(!FluentValue::from("two").matches(&FluentValue::try_number("100"), &scope),);

pub fn write<W, R, M>( &self, w: &mut W, scope: &Scope<'_, '_, '_, '_, R, M>, ) -> Result

where W: Write, R: Borrow<FluentResource>, M: MemoizerKind,

Write out a string version of the FluentValue to W.

pub fn as_string<R: Borrow<FluentResource>, M>( &self, scope: &Scope<'_, '_, '_, '_, R, M>, ) -> Cow<'source, str>

where M: MemoizerKind,

Converts the FluentValue to a string.

Clones inner values when owned, borrowed data is not cloned. Prefer using FluentValue::into_string() when possible.

pub fn into_string<R: Borrow<FluentResource>, M>( self, scope: &Scope<'_, '_, '_, '_, R, M>, ) -> Cow<'source, str>

where M: MemoizerKind,

Converts the FluentValue to a string.

Takes self by-value to be able to skip expensive clones. Prefer this method over FluentValue::as_string() when possible.

pub fn into_owned<'a>(&self) -> FluentValue<'a>

Trait Implementations

impl Clone for FluentValue<'_>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'source> Debug for FluentValue<'source>

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

Formats the value using the given formatter.

impl<'source> From<&'source String> for FluentValue<'source>

fn from(s: &'source String) -> Self

Converts to this type from the input type.

impl From<&f32> for FluentValue<'_>

fn from(n: &f32) -> Self

Converts to this type from the input type.

impl From<&f64> for FluentValue<'_>

fn from(n: &f64) -> Self

Converts to this type from the input type.

impl From<&i128> for FluentValue<'_>

fn from(n: &i128) -> Self

Converts to this type from the input type.

impl From<&i16> for FluentValue<'_>

fn from(n: &i16) -> Self

Converts to this type from the input type.

impl From<&i32> for FluentValue<'_>

fn from(n: &i32) -> Self

Converts to this type from the input type.

impl From<&i64> for FluentValue<'_>

fn from(n: &i64) -> Self

Converts to this type from the input type.

impl From<&i8> for FluentValue<'_>

fn from(n: &i8) -> Self

Converts to this type from the input type.

impl From<&isize> for FluentValue<'_>

fn from(n: &isize) -> Self

Converts to this type from the input type.

impl<'source> From<&'source str> for FluentValue<'source>

fn from(s: &'source str) -> Self

Converts to this type from the input type.

impl From<&u128> for FluentValue<'_>

fn from(n: &u128) -> Self

Converts to this type from the input type.

impl From<&u16> for FluentValue<'_>

fn from(n: &u16) -> Self

Converts to this type from the input type.

impl From<&u32> for FluentValue<'_>

fn from(n: &u32) -> Self

Converts to this type from the input type.

impl From<&u64> for FluentValue<'_>

fn from(n: &u64) -> Self

Converts to this type from the input type.

impl From<&u8> for FluentValue<'_>

fn from(n: &u8) -> Self

Converts to this type from the input type.

impl From<&usize> for FluentValue<'_>

fn from(n: &usize) -> Self

Converts to this type from the input type.

impl<'source> From<Cow<'source, str>> for FluentValue<'source>

fn from(s: Cow<'source, str>) -> Self

Converts to this type from the input type.

impl From<FluentNumber> for FluentValue<'_>

fn from(input: FluentNumber) -> Self

Converts to this type from the input type.

impl<'source, T> From<Option<T>> for FluentValue<'source>

where T: Into<FluentValue<'source>>,

fn from(v: Option<T>) -> Self

Converts to this type from the input type.

impl From<String> for FluentValue<'_>

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<f32> for FluentValue<'_>

fn from(n: f32) -> Self

Converts to this type from the input type.

impl From<f64> for FluentValue<'_>

fn from(n: f64) -> Self

Converts to this type from the input type.

impl From<i128> for FluentValue<'_>

fn from(n: i128) -> Self

Converts to this type from the input type.

impl From<i16> for FluentValue<'_>

fn from(n: i16) -> Self

Converts to this type from the input type.

impl From<i32> for FluentValue<'_>

fn from(n: i32) -> Self

Converts to this type from the input type.

impl From<i64> for FluentValue<'_>

fn from(n: i64) -> Self

Converts to this type from the input type.

impl From<i8> for FluentValue<'_>

fn from(n: i8) -> Self

Converts to this type from the input type.

impl From<isize> for FluentValue<'_>

fn from(n: isize) -> Self

Converts to this type from the input type.

impl From<u128> for FluentValue<'_>

fn from(n: u128) -> Self

Converts to this type from the input type.

impl From<u16> for FluentValue<'_>

fn from(n: u16) -> Self

Converts to this type from the input type.

impl From<u32> for FluentValue<'_>

fn from(n: u32) -> Self

Converts to this type from the input type.

impl From<u64> for FluentValue<'_>

fn from(n: u64) -> Self

Converts to this type from the input type.

impl From<u8> for FluentValue<'_>

fn from(n: u8) -> Self

Converts to this type from the input type.

impl From<usize> for FluentValue<'_>

fn from(n: usize) -> Self

Converts to this type from the input type.

impl PartialEq for FluentValue<'_>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.