Struct SubdivisionId 

#[non_exhaustive]
pub struct SubdivisionId {
    pub region: Region,
    pub suffix: SubdivisionSuffix,
}

A Subivision Id as defined in Unicode Locale Identifier.

Subdivision Id is used in Unicode extensions:

• rg - Regional Override
• sd - Regional Subdivision

In both cases the subdivision is composed of a Region and a SubdivisionSuffix which represents different meaning depending on the key.

Examples

use icu::locale::{
    extensions::unicode::{subdivision_suffix, SubdivisionId},
    subtags::region,
};

let ss = subdivision_suffix!("zzzz");
let region = region!("gb");

let si = SubdivisionId::new(region, ss);

assert_eq!(si.to_string(), "gbzzzz");

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

region: Region

A region field of a Subdivision Id.

suffix: SubdivisionSuffix

A subdivision suffix field of a Subdivision Id.

Implementations

impl SubdivisionId

pub const fn new(region: Region, suffix: SubdivisionSuffix) -> Self

Returns a new SubdivisionId.

Examples

use icu::locale::{
    extensions::unicode::{subdivision_suffix, SubdivisionId},
    subtags::region,
};

let ss = subdivision_suffix!("zzzz");
let region = region!("gb");

let si = SubdivisionId::new(region, ss);

assert_eq!(si.to_string(), "gbzzzz");

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

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

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

See Self::try_from_str

pub fn into_subtag(self) -> Subtag

Convert to Subtag

impl SubdivisionId

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 SubdivisionId

fn clone(&self) -> SubdivisionId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubdivisionId

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

Formats the value using the given formatter.

impl Display for SubdivisionId

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

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 SubdivisionId

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 Ord for SubdivisionId

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

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

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

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_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 Copy for SubdivisionId

impl Eq for SubdivisionId

impl StructuralPartialEq for SubdivisionId

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 7 bytes