Struct Subtag 

#[repr(transparent)]
pub struct Subtag(TinyAsciiStr<8>);

A single item used in a list of Private extensions.

The subtag has to be an ASCII alphanumerical string no shorter than one character and no longer than eight.

Examples

use icu::locale::extensions::private::Subtag;

let subtag1: Subtag = "Foo".parse()
    .expect("Failed to parse a Subtag.");

assert_eq!(subtag1.as_str(), "foo");

Notice: This is different from the generic Subtag which is between two and eight characters.

use icu::locale::extensions::private;
use icu::locale::subtags;

let subtag: Result<private::Subtag, _> = "f".parse();
assert!(subtag.is_ok());

let subtag: Result<subtags::Subtag, _> = "f".parse();
assert!(subtag.is_err());

Tuple Fields

0: TinyAsciiStr<8>

Implementations

impl Subtag

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

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

Examples

use icu_locale_core::extensions :: private ::Subtag;

assert!(Subtag::try_from_str("foo12").is_ok());
assert!(Subtag::try_from_str("toolooong").is_err());

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

See Self::try_from_str

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

Safely creates a Subtag 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]) -> Subtag

Unsafely creates a Subtag 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 Subtag

pub fn to_string(&self) -> String

Converts the given value to a String.

Under the hood, this uses an efficient [Writeable] implementation.

If you don’t need an allocated [String], but e.g. need to write this to some sink, it is more efficient to use [Writeable] directly.

Trait Implementations

impl AsULE for Subtag

Available on crate feature zerovec only.

type ULE = Subtag

The ULE type corresponding to Self.

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

Converts from Self to Self::ULE.

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

Converts from Self::ULE to Self.

impl Clone for Subtag

fn clone(&self) -> Subtag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Subtag

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

Formats the value using the given formatter.

impl Display for Subtag

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 Subtag> for &'l str

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

Converts to this type from the input type.

impl From<Subtag> for TinyAsciiStr<8>

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

Converts to this type from the input type.

impl FromStr for Subtag

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl Hash for Subtag

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 Subtag

Available on crate feature zerovec only.

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

impl Ord for Subtag

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

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

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

Available on crate feature zerovec only.

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 Subtag

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 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 writeable_length_hint(&self) -> LengthHint

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

fn writeable_borrow(&self) -> Option<&str>

Returns a &str that matches the output of write_to, if possible.

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

Creates a new string with the data from this Writeable.

impl<'a> ZeroMapKV<'a> for Subtag

Available on crate features zerovec and alloc only.

type Container = ZeroVec<'a, Subtag>

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

type Slice = ZeroSlice<Subtag>

type GetType = Subtag

The type produced by Container::get()

type OwnedType = Subtag

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 Subtag

impl Eq for Subtag

impl StructuralPartialEq for Subtag