Struct unicode_script::ScriptExtension

#[non_exhaustive]
pub struct ScriptExtension {
    pub(crate) first: u64,
    pub(crate) second: u64,
    pub(crate) third: u64,
    pub(crate) common: bool,
}

A value for the Script_Extension property

ScriptExtension is one or more Script

This is essentially an optimized version of Vec<Script> that uses bitfields

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.

first: u64

second: u64

third: u64

common: bool

Implementations

impl ScriptExtension

pub(crate) const THIRD_MAX: u64 = 1_099_511_627_775u64

pub(crate) const fn new(first: u64, second: u64, third: u64) -> Self

pub(crate) const fn new_common() -> Self

pub(crate) const fn new_inherited() -> Self

pub(crate) const fn new_unknown() -> Self

pub(crate) const fn is_common_or_inherited(self) -> bool

pub const fn is_common(self) -> bool

Checks if the script extension is Common

pub const fn is_inherited(self) -> bool

Checks if the script extension is Inherited

pub const fn is_empty(self) -> bool

Checks if the script extension is empty (unknown)

pub fn len(self) -> usize

Returns the number of scripts in the script extension

pub fn intersect_with(&mut self, other: Self)

Intersect this ScriptExtension with another ScriptExtension. Produces Unknown if things do not intersect. This is equivalent to ScriptExtension::intersection but it stores the result in self

“Common” (Zyyy) and “Inherited” (Zinh) are considered as intersecting everything, the intersection of Common and Inherited is Inherited

pub const fn intersection(self, other: Self) -> Self

Find the intersection between two ScriptExtensions. Returns Unknown if things do not intersect.

“Common” (Zyyy) and “Inherited” (Zinh) are considered as intersecting everything, the intersection of Common and Inherited is Inherited

pub const fn union(self, other: Self) -> Self

Find the union between two ScriptExtensions.

“Common” (Zyyy) and “Inherited” (Zinh) are considered as intersecting everything, the union of Common and Inherited is Common

pub fn contains_script(self, script: Script) -> bool

Check if this ScriptExtension contains the given script

Should be used with specific scripts only, this will return true if self is not Unknown and script is Common or Inherited

pub fn for_str(x: &str) -> Self

Get the intersection of script extensions of all characters in a string.

pub fn iter(self) -> ScriptIterator

Iterate over the scripts in this script extension

Will never yield Script::Unknown

Trait Implementations

impl Clone for ScriptExtension

fn clone(&self) -> ScriptExtension

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScriptExtension

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

Formats the value using the given formatter.

impl Default for ScriptExtension

fn default() -> Self

Returns the “default value” for a type.

impl Display for ScriptExtension

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

Formats the value using the given formatter.

impl From<&str> for ScriptExtension

fn from(o: &str) -> Self

Converts to this type from the input type.

impl From<Script> for ScriptExtension

fn from(script: Script) -> Self

Converts to this type from the input type.

impl From<char> for ScriptExtension

fn from(o: char) -> Self

Converts to this type from the input type.

impl Hash for ScriptExtension

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 PartialEq for ScriptExtension

fn eq(&self, other: &ScriptExtension) -> 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 TryFrom<ScriptExtension> for Script

type Error = ()

The type returned in the event of a conversion error.

fn try_from(ext: ScriptExtension) -> Result<Self, ()>

Performs the conversion.

impl Copy for ScriptExtension

impl Eq for ScriptExtension

impl StructuralPartialEq for ScriptExtension