Struct Value

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

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

impl Value

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

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

See Self::try_from_str

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());

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());

pub fn push_subtag(&mut self, subtag: Subtag)

Appends a subtag to the back of a Value.

Examples

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

let mut v = Value::default();
v.push_subtag(subtag!("foo"));
v.push_subtag(subtag!("bar"));
assert_eq!(v, "foo-bar");

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

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());

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_eq!(v.is_empty(), true);

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

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

pub fn from_vec_unchecked(input: Vec<Subtag>) -> Self

A constructor which takes a pre-sorted list of Value elements.

Examples

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

let subtag1 = subtag!("foobar");
let subtag2 = subtag!("testing");
let mut v = vec![subtag1, subtag2];
v.sort();
v.dedup();

let value = Value::from_vec_unchecked(v);

Notice: For performance- and memory-constrained environments, it is recommended for the caller to use binary_search instead of sort and dedup.

impl Value

pub fn to_string(&self) -> String

Converts the given value to a String.

Under the hood, this uses an efficient [Writeable] implementation. However, in order to avoid allocating a string, it is more efficient to use [Writeable] directly.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Default for Value

fn default() -> Value

Returns the “default value” for a type.

impl Display for Value

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

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

Formats the value using the given formatter.

impl Extend<Subtag> for Value

fn extend<T: IntoIterator<Item = Subtag>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<CalendarAlgorithm> for Value

fn from(input: CalendarAlgorithm) -> Value

Converts to this type from the input type.

impl From<CollationCaseFirst> for Value

fn from(input: CollationCaseFirst) -> Value

Converts to this type from the input type.

impl From<CollationNumericOrdering> for Value

fn from(input: CollationNumericOrdering) -> Value

Converts to this type from the input type.

impl From<CollationType> for Value

fn from(input: CollationType) -> Value

Converts to this type from the input type.

impl From<CommonVariantType> for Value

fn from(input: CommonVariantType) -> Value

Converts to this type from the input type.

impl From<CurrencyFormatStyle> for Value

fn from(input: CurrencyFormatStyle) -> Value

Converts to this type from the input type.

impl From<CurrencyType> for Value

fn from(input: CurrencyType) -> Value

Converts to this type from the input type.

impl From<DictionaryBreakScriptExclusions> for Value

fn from(input: DictionaryBreakScriptExclusions) -> Value

Converts to this type from the input type.

impl From<EmojiPresentationStyle> for Value

fn from(input: EmojiPresentationStyle) -> Value

Converts to this type from the input type.

impl From<FirstDay> for Value

fn from(input: FirstDay) -> Value

Converts to this type from the input type.

impl From<HourCycle> for Value

fn from(input: HourCycle) -> Value

Converts to this type from the input type.

impl From<LineBreakStyle> for Value

fn from(input: LineBreakStyle) -> Value

Converts to this type from the input type.

impl From<LineBreakWordHandling> for Value

fn from(input: LineBreakWordHandling) -> Value

Converts to this type from the input type.

impl From<MeasurementSystem> for Value

fn from(input: MeasurementSystem) -> Value

Converts to this type from the input type.

impl From<MeasurementUnitOverride> for Value

fn from(input: MeasurementUnitOverride) -> Value

Converts to this type from the input type.

impl From<NumberingSystem> for Value

fn from(input: NumberingSystem) -> Value

Converts to this type from the input type.

impl From<RegionOverride> for Value

fn from(input: RegionOverride) -> Value

Converts to this type from the input type.

impl From<RegionalSubdivision> for Value

fn from(input: RegionalSubdivision) -> Value

Converts to this type from the input type.

impl From<SentenceBreakSupressions> for Value

fn from(input: SentenceBreakSupressions) -> Value

Converts to this type from the input type.

impl From<TimeZoneShortId> for Value

fn from(input: TimeZoneShortId) -> Value

Converts to this type from the input type.

impl FromIterator<Subtag> for Value

fn from_iter<T: IntoIterator<Item = Subtag>>(iter: T) -> Self

Creates a value from an iterator.

impl FromStr for Value

type Err = ParseError

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 Value

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 IntoIterator for Value

type Item = Subtag

The type of the elements being iterated over.

type IntoIter = ShortBoxSliceIntoIter<Subtag>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for Value

fn cmp(&self, other: &Value) -> 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<&str> for Value

fn eq(&self, other: &&str) -> 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 PartialEq for Value

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

fn partial_cmp(&self, other: &Value) -> 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 TryFrom<&Value> for CalendarAlgorithm

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(s: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for CollationCaseFirst

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(s: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for CollationNumericOrdering

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(s: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for CollationType

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(s: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for CommonVariantType

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(s: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for CurrencyFormatStyle

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(s: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for EmojiPresentationStyle

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(s: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for FirstDay

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(s: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for HourCycle

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(s: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for LineBreakStyle

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(s: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for LineBreakWordHandling

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(s: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for MeasurementSystem

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(s: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for MeasurementUnitOverride

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(s: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Value> for SentenceBreakSupressions

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(s: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for CurrencyType

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(input: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for DictionaryBreakScriptExclusions

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(input: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for NumberingSystem

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(input: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for RegionOverride

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(input: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for RegionalSubdivision

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(input: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for TimeZoneShortId

type Error = PreferencesParseError

The type returned in the event of a conversion error.

fn try_from(input: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl Writeable for Value

fn write_to<W: Write + ?Sized>(&self, sink: &mut W) -> Result

Writes a string to the given sink. Errors from the sink are bubbled up. The default implementation delegates to write_to_parts, and discards any Part annotations.

fn writeable_length_hint(&self) -> LengthHint

Returns a hint for the number of UTF-8 bytes that will be written to the sink.

fn write_to_string(&self) -> Cow<'_, str>

Creates a new String with the data from this Writeable. Like ToString, but smaller and faster.

fn write_to_parts<S>(&self, sink: &mut S) -> Result<(), Error>

where S: PartsWrite + ?Sized,

Write bytes and Part annotations to the given sink. Errors from the sink are bubbled up. The default implementation delegates to write_to, and doesn’t produce any Part annotations.

impl Eq for Value

impl StructuralPartialEq for Value