Struct icu_locid::extensions::unicode::Key

pub struct Key(_);

A key used in a list of Keywords.

The key has to be a two ASCII alphanumerical characters long, with the first character being alphanumeric, and the second being alphabetic.

Examples

use icu::locid::extensions::unicode::Key;

let key1: Key = "ca".parse()
    .expect("Failed to parse a Key.");

assert_eq!(key1, "ca");

Implementations

impl Key

pub fn from_bytes(key: &[u8]) -> Result<Self, ParserError>

A constructor which takes a utf8 slice, parses it and produces a well-formed Key.

Examples

use icu::locid::extensions::unicode::Key;

let key = Key::from_bytes(b"ca")
    .expect("Parsing failed.");

assert_eq!(key, "ca");

pub fn as_str(&self) -> &str

A helper function for displaying a Key subtag as a &str.

Examples

use icu::locid::extensions::unicode::Key;

let key: Key = "ca".parse().expect("Parsing failed.");

assert_eq!(key.as_str(), "ca");

Notice: For many use cases, such as comparison, Key implements PartialEq<&str> which allows for direct comparisons.

Trait Implementations

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Key

impl Debug for Key

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

Formats the value using the given formatter.

impl Display for Key

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

Formats the value using the given formatter.

impl Eq for Key

impl FromStr for Key

type Err = ParserError

The associated error which can be returned from parsing.

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

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

impl Hash for Key

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for Key

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<&'_ str> for Key

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

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

This method tests for !=.

impl PartialEq<Key> for Key

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Key> for Key

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

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

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

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

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

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

impl StructuralEq for Key

impl StructuralPartialEq for Key

impl Writeable for Key

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

Writes bytes to the given sink. Errors from the sink are bubbled up.

fn write_len(&self) -> LengthHint

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

pub fn writeable_to_string(&self) -> String

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