Struct icu_locale::subtags::Variant

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

A variant subtag (examples: "macos", "posix", "1996" etc.)

Variant represents a Unicode base language code conformant to the unicode_variant_id field of the Language and Locale Identifier.

Examples

use icu::locale::subtags::Variant;

let variant: Variant =
    "macos".parse().expect("Failed to parse a variant subtag.");

Implementations

impl Variant

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

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

Examples

use icu_locale_core::subtags ::Variant;

assert!(Variant::try_from_str("posix").is_ok());
assert!(Variant::try_from_str("yes").is_err());

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

See Self::try_from_str

pub const fn try_from_raw(raw: [u8; 8]) -> Result<Variant, ParseError>

Safely creates a Variant from its raw format as returned by Self::into_raw. Unlike Self::try_from_utf8, this constructor only takes normalized values.

pub const unsafe fn from_raw_unchecked(v: [u8; 8]) -> Variant

Unsafely creates a Variant from its raw format as returned by Self::into_raw. Unlike Self::try_from_utf8, this constructor only takes normalized values.

Safety

This function is safe iff Self::try_from_raw returns an Ok. This is the case for inputs that are correctly normalized.

pub const fn into_raw(self) -> [u8; 8]

Deconstructs into a raw format to be consumed by from_raw_unchecked or try_from_raw.

pub const fn as_str(&self) -> &str

A helper function for displaying as a &str.

pub fn strict_cmp(self, other: &[u8]) -> Ordering

Compare with BCP-47 bytes.

The return value is equivalent to what would happen if you first converted self to a BCP-47 string and then performed a byte comparison.

This function is case-sensitive and results in a total order, so it is appropriate for binary search. The only argument producing Ordering::Equal is self.as_str().as_bytes().

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

Compare with a potentially unnormalized BCP-47 string.

The return value is equivalent to what would happen if you first parsed the BCP-47 string and then performed a structural comparison.

impl Variant

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 AsULE for Variant

type ULE = Variant

The ULE type corresponding to Self.

fn to_unaligned(self) -> <Variant as AsULE>::ULE

Converts from Self to Self::ULE.

fn from_unaligned(unaligned: <Variant as AsULE>::ULE) -> Variant

Converts from Self::ULE to Self.

impl Bake for Variant

fn bake(&self, env: &CrateEnv) -> TokenStream

Returns a TokenStream that would evaluate to self.

impl BakeSize for Variant

fn borrows_size(&self) -> usize

Returns the size

impl Clone for Variant

fn clone(&self) -> Variant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Variant

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Variant

fn deserialize<D>( deserializer: D, ) -> Result<Variant, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Variant

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<(), Error>

Formats the value using the given formatter.

impl<'l> From<&'l Variant> for &'l str

fn from(input: &'l Variant) -> &'l str

Converts to this type from the input type.

impl From<Variant> for TinyAsciiStr<8>

fn from(input: Variant) -> TinyAsciiStr<8>

Converts to this type from the input type.

impl FromStr for Variant

type Err = ParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Variant, <Variant as FromStr>::Err>

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

impl Hash for Variant

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

where __H: Hasher,

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 NicheBytes<8> for Variant

const NICHE_BIT_PATTERN: [u8; 8] = tinystr::TinyAsciiStr<8>::NICHE_BIT_PATTERN

impl Ord for Variant

fn cmp(&self, other: &Variant) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Variant

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

fn partial_cmp(&self, other: &Variant) -> 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 Serialize for Variant

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ULE for Variant

fn validate_bytes(bytes: &[u8]) -> Result<(), UleError>

Validates a byte slice, &[u8].

fn parse_bytes_to_slice(bytes: &[u8]) -> Result<&[Self], UleError>

Parses a byte slice, &[u8], and return it as &[Self] with the same lifetime.

unsafe fn slice_from_bytes_unchecked(bytes: &[u8]) -> &[Self]

Takes a byte slice, &[u8], and return it as &[Self] with the same lifetime, assuming that this byte slice has previously been run through [Self::parse_bytes_to_slice()] with success.

fn slice_as_bytes(slice: &[Self]) -> &[u8]

Given &[Self], returns a &[u8] with the same lifetime.

impl Writeable for Variant

fn write_to<W>(&self, sink: &mut W) -> Result<(), Error>

where W: Write + ?Sized,

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<'a> ZeroMapKV<'a> for Variant

type Container = ZeroVec<'a, Variant>

The container that can be used with this type: [ZeroVec] or [VarZeroVec].

type Slice = ZeroSlice<Variant>

type GetType = Variant

The type produced by Container::get()

type OwnedType = Variant

The type produced by Container::replace() and Container::remove(), also used during deserialization. If Self is human readable serialized, deserializing to Self::OwnedType should produce the same value once passed through Self::owned_as_self()

impl Copy for Variant

impl Eq for Variant

impl StructuralPartialEq for Variant