Enum I18nString 

#[non_exhaustive]
pub enum I18nString {
    Literal(CompactString),
    Template(CompactString, Box<[I18nString]>),
}

A string that can be translated into multiple languages.

Examples

Basic example.

use std::borrow::Cow;

use i18n_string::{I18nString, Resolver};

struct SimpleResolver;

impl Resolver for SimpleResolver {
    fn resolve<'s>(&'s self, template: &'s str) -> Cow<'s, str> {
        match template {
            "world" => Cow::Borrowed("<translated world>"),
            _ => template.into(),
        }
    }
}

let s = I18nString::template("hello {0}, you are {1}", [I18nString::template("world", []), I18nString::literal("123")]);
assert_eq!(s.translate(&SimpleResolver), "hello <translated world>, you are 123");

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Literal(CompactString)

A literal string.

Template(CompactString, Box<[I18nString]>)

A template string.

Implementations

impl I18nString

pub fn translate<R: Resolver>(&self, resolver: R) -> String

impl I18nString

pub fn literal<S: Into<CompactString>>(s: S) -> Self

Create a new I18nString::Literal from a string.

Examples

Basic example.

use i18n_string::I18nString;

let s = I18nString::literal("hello");
assert_eq!(s, I18nString::Literal("hello".into()));

pub fn template<S: Into<CompactString>, ARGS: IntoIterator<Item = I18nString>>( s: S, args: ARGS, ) -> Self

Create a new I18nString::Template from a string and arguments.

Examples

Basic example.

use i18n_string::I18nString;

let s = I18nString::template("hello {}", [I18nString::literal("world")]);
assert_eq!(s, I18nString::Template("hello {}".into(), [I18nString::Literal("world".into())].into()));

Trait Implementations

impl Clone for I18nString

fn clone(&self) -> I18nString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for I18nString

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

Formats the value using the given formatter.

impl Display for I18nString

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

Formats the value using the given formatter.

impl FromStr for I18nString

type Err = InvalidFormat

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for I18nString

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl I18nStringBuilderExt for I18nString

fn display<D: Display + ?Sized>(display: &D) -> Self

Create a new I18nString::Literal from a Display type.

fn debug<D: Debug + ?Sized>(debug: &D) -> Self

Create a new I18nString::Literal from a Debug type.

fn template_display<D: Display + ?Sized>(display: &D) -> Self

Create a new I18nString::Template from a Display type.

fn template_debug<D: Debug + ?Sized>(debug: &D) -> Self

Create a new I18nString::Template from a Debug type.

impl I18nStringTranslateExt for I18nString

fn to_no_translate_string(&self) -> String

Translate the I18nString into a no-translate string.

impl Ord for I18nString

fn cmp(&self, other: &I18nString) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for I18nString

fn eq(&self, other: &I18nString) -> 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.

impl PartialOrd for I18nString

fn partial_cmp(&self, other: &I18nString) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for I18nString

impl StructuralPartialEq for I18nString