Struct icu_locid::subtags::Script

pub struct Script(_);

A script subtag (examples: "Latn", "Arab", etc.)

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

Examples

use icu::locid::subtags::Script;

let script: Script = "Latn".parse()
    .expect("Failed to parse a script subtag.");

Implementations

impl Script

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

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

Examples

use icu::locid::subtags::Script;

let script = Script::from_bytes(b"Latn")
    .expect("Parsing failed.");

assert_eq!(script, "Latn");

pub fn into_raw(self) -> u32

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

Examples

use icu::locid::subtags::Script;

let script = Script::from_bytes(b"Latn")
    .expect("Parsing failed.");

let raw = script.into_raw();
let script = unsafe { Script::from_raw_unchecked(raw) };
assert_eq!(script, "Latn");

pub const unsafe fn from_raw_unchecked(v: u32) -> Self

Constructor which takes a raw value returned by into_raw.

Examples

use icu::locid::subtags::Script;

let script = Script::from_bytes(b"Latn")
    .expect("Parsing failed.");

let raw = script.into_raw();
let script = unsafe { Script::from_raw_unchecked(raw) };
assert_eq!(script, "Latn");

Safety

This function accepts a u32 that is expected to be a valid TinyStr4 representing a Script subtag in canonical syntax.

pub fn as_str(&self) -> &str

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

Examples

use icu::locid::subtags::Script;

let script = Script::from_bytes(b"Latn")
    .expect("Parsing failed.");

assert_eq!(script.as_str(), "Latn");

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

Trait Implementations

impl Clone for Script

fn clone(&self) -> Script

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Script

impl Debug for Script

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

Formats the value using the given formatter.

impl Display for Script

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

Formats the value using the given formatter.

impl Eq for Script

impl FromStr for Script

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 Script

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 Script

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

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

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

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

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

This method tests for !=.

impl PartialOrd<Script> for Script

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

impl StructuralPartialEq for Script

impl Writeable for Script

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.