Struct icu::locid::subtags::Variant

#[repr(transparent)]
pub struct Variant(_);

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

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

Examples

use icu::locid::subtags::Variant;

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

Implementations

impl Variant

pub const fn from_bytes(v: &[u8]) -> Result<Variant, ParserError>

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

Examples

use icu::locid::subtags::Variant;

let variant = Variant::from_bytes(b"posix")
    .expect("Parsing failed.");

assert_eq!(variant, "posix");

pub const fn from_bytes_manual_slice(
    v: &[u8],
    start: usize,
    end: usize
) -> Result<Variant, ParserError>

Equivalent to from_bytes(bytes[start..end]), but callable in a const context (which range indexing is not).

pub fn try_from_raw(v: [u8; 8]) -> Result<Variant, ParserError>

Safely creates a Variant from a reference to its raw format as returned by Variant::into_raw().

Examples

use icu::locid::subtags::Variant;

assert!(matches!(Variant::try_from_raw(*b"fonipa\0\0"), Ok(_)));
assert!(matches!(Variant::try_from_raw(*b"1992\0\0\0\0"), Ok(_)));
assert!(matches!(Variant::try_from_raw(*b"foo\0\0\0\0\0"), Err(_)));

// Unlike the other constructors, this one is case-sensitive:
assert!(matches!(Variant::try_from_raw(*b"POSIX\0\0\0"), Err(_)));

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

Deconstructs the Variant into raw format to be consumed by from_raw_unchecked().

Examples

use icu::locid::subtags::Variant;

let variant = Variant::from_bytes(b"posix")
    .expect("Parsing failed.");

let raw = variant.into_raw();
let variant = unsafe { Variant::from_raw_unchecked(raw) };
assert_eq!(variant, "posix");

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

Constructor which takes a raw value returned by into_raw().

Examples

use icu::locid::subtags::Variant;

let variant = Variant::from_bytes(b"posix")
    .expect("Parsing failed.");

let raw = variant.into_raw();
let variant = unsafe { Variant::from_raw_unchecked(raw) };
assert_eq!(variant, "posix");

Safety

This function accepts a [u8; 8] that is expected to be a valid [TinyAsciiStr<8>] representing a Variant subtag in canonical syntax.

pub fn as_str(&self) -> &str

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

Examples

use icu::locid::subtags::Variant;

let variant = Variant::from_bytes(b"macos")
    .expect("Parsing failed.");

assert_eq!(variant.as_str(), "macos");

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

Trait Implementations

impl AsULE for Variant

Impl enabling Variant to be used in a ZeroVec. Enabled with the "zerovec" feature.

Example

use icu::locid::subtags::Variant;
use icu::locid::variant;
use zerovec::ZeroVec;

let zv = ZeroVec::<Variant>::parse_byte_slice(b"fonipa\0\01992\0\0\0\0posix\0\0\0")
    .expect("Valid variant subtags");
assert_eq!(zv.get(1), Some(variant!("1992")));

ZeroVec::<Variant>::parse_byte_slice(b"invalid")
    .expect_err("Invalid byte slice");

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

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

type Err = ParserError

The associated error which can be returned from parsing.

fn from_str(source: &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, 

Feeds a slice of this type into the given Hasher.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<'_> PartialEq<&'_ str> for Variant

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

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

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

This method tests for !=.

impl PartialEq<Variant> for Variant

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

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

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

This method tests for !=.

impl PartialEq<str> for Variant

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

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

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

This method tests for !=.

impl<'_> PartialOrd<&'_ str> for Variant

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

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

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

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

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

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

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

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

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 PartialOrd<Variant> 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

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

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

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

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

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

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 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_byte_slice(bytes: &[u8]) -> Result<(), ZeroVecError>

Validates a byte slice, &[u8].

fn parse_byte_slice(bytes: &[u8]) -> Result<&[Self], ZeroVecError>

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

unsafe fn from_byte_slice_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_byte_slice()] with success.

fn as_byte_slice(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 bytes 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 write_len(&self) -> LengthHint

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

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.

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

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

impl<'a> ZeroMapKV<'a> for Variant

type Container = ZeroVec<'a, Variant>

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

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

impl StructuralPartialEq for Variant