Struct Value

Source

pub struct Value(/* private fields */);

Expand description

A value used in a list of Keywords.

The value has to be a sequence of one or more alphanumerical strings separated by -. Each part of the sequence has to be no shorter than three characters and no longer than 8.

§Examples

use icu::locale::extensions::unicode::{value, Value};
use writeable::assert_writeable_eq;

assert_writeable_eq!(value!("gregory"), "gregory");
assert_writeable_eq!(
    "islamic-civil".parse::<Value>().unwrap(),
    "islamic-civil"
);

// The value "true" has the special, empty string representation
assert_eq!(value!("true").to_string(), "");

Implementations§

Source §

impl Value

Source

pub fn try_from_str(s: &str) -> Result<Self, ParseError>

A constructor which str slice, parses it and produces a well-formed Value.

§Examples

use icu::locale::extensions::unicode::Value;

Value::try_from_str("buddhist").expect("Parsing failed.");

§`alloc` Cargo feature

Without the alloc Cargo feature, this only supports parsing up to two (non-true) subtags, and will return an error for longer strings.

Source

pub fn try_from_utf8(code_units: &[u8]) -> Result<Self, ParseError>

See Self::try_from_str

Source

pub const fn as_single_subtag(&self) -> Option<&Subtag>

Returns a reference to a single Subtag if the Value contains exactly one subtag, or None otherwise.

§Examples

use core::str::FromStr;
use icu::locale::extensions::unicode::Value;

let value1 = Value::from_str("foo").expect("failed to parse a Value");
let value2 = Value::from_str("foo-bar").expect("failed to parse a Value");

assert!(value1.as_single_subtag().is_some());
assert!(value2.as_single_subtag().is_none());

Source

pub fn into_single_subtag(self) -> Option<Subtag>

Destructs into a single Subtag if the Value contains exactly one subtag, or returns None otherwise.

§Examples

use core::str::FromStr;
use icu::locale::extensions::unicode::Value;

let value1 = Value::from_str("foo").expect("failed to parse a Value");
let value2 = Value::from_str("foo-bar").expect("failed to parse a Value");

assert!(value1.into_single_subtag().is_some());
assert!(value2.into_single_subtag().is_none());

Source

pub fn subtag_count(&self) -> usize

Returns the number of subtags in the Value.

§Examples

use icu::locale::{extensions::unicode::Value, subtags::subtag};

let mut v = Value::default();
assert_eq!(v.subtag_count(), 0);
v.push_subtag(subtag!("foo"));
assert_eq!(v.subtag_count(), 1);

Source

pub const fn new_empty() -> Self

Creates an empty Value, which corresponds to a “true” value.

§Examples

use icu::locale::extensions::unicode::{value, Value};

assert_eq!(value!("true"), Value::new_empty());

Source

pub fn is_empty(&self) -> bool

Returns true if the Value has no subtags.

§Examples

use icu::locale::{extensions::unicode::Value, subtags::subtag};

let mut v = Value::default();
assert!(v.is_empty());

Source

pub fn remove_subtag(&mut self, idx: usize) -> Option<Subtag>

Removes and returns the subtag at position index within the value, shifting all subtags after it to the left.

§Examples

use icu::locale::{extensions::unicode::Value, subtags::subtag};
let mut v = Value::default();
v.push_subtag(subtag!("foo"));
v.push_subtag(subtag!("bar"));
v.push_subtag(subtag!("baz"));

assert_eq!(v.remove_subtag(1), Some(subtag!("bar")));
assert_eq!(v, "foo-baz");

Source

pub fn get_subtag(&self, idx: usize) -> Option<&Subtag>

Returns a reference to a subtag at index.

§Examples

use icu::locale::{extensions::unicode::Value, subtags::subtag};
let mut v = Value::default();
v.push_subtag(subtag!("foo"));
v.push_subtag(subtag!("bar"));
v.push_subtag(subtag!("baz"));

assert_eq!(v.get_subtag(1), Some(&subtag!("bar")));
assert_eq!(v.get_subtag(3), None);

Trait Implementations§

Source §

impl Clone for Value

Source §

fn clone(&self) -> Value

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for Value

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for Value

Source §

fn default() -> Value

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

Source §

impl Display for Value

This trait is implemented for compatibility with fmt!. To create a string, [Writeable::write_to_string] is usually more efficient.

Source §

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

Formats the value using the given formatter. Read more

Source §