Struct WordBreak

#[repr(transparent)]
pub struct WordBreak(pub u8);

Enumerated property Word_Break.

See “Default Word Boundary Specification” in UAX #29 for the summary of each property value: https://www.unicode.org/reports/tr29/#Default_Word_Boundaries.

The numeric value is compatible with UWordBreakValues in ICU4C.

Tuple Fields

0: u8

Implementations

impl WordBreak

pub const Other: WordBreak = _

pub const ALetter: WordBreak = _

pub const Format: WordBreak = _

pub const Katakana: WordBreak = _

pub const MidLetter: WordBreak = _

pub const MidNum: WordBreak = _

pub const Numeric: WordBreak = _

pub const ExtendNumLet: WordBreak = _

pub const CR: WordBreak = _

pub const Extend: WordBreak = _

pub const LF: WordBreak = _

pub const MidNumLet: WordBreak = _

pub const Newline: WordBreak = _

pub const RegionalIndicator: WordBreak = _

pub const HebrewLetter: WordBreak = _

pub const SingleQuote: WordBreak = _

pub const DoubleQuote: WordBreak = _

pub const EBase: WordBreak = _

This value is obsolete and unused.

pub const EBaseGAZ: WordBreak = _

This value is obsolete and unused.

pub const EModifier: WordBreak = _

This value is obsolete and unused.

pub const GlueAfterZwj: WordBreak = _

This value is obsolete and unused.

pub const ZWJ: WordBreak = _

pub const WSegSpace: WordBreak = _

impl WordBreak

pub const fn name_to_enum_mapper() -> PropertyValueNameToEnumMapperBorrowed<'static, WordBreak>

Return a PropertyValueNameToEnumMapper, capable of looking up values from strings for the Word_Break enumerated property.

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

Example

use icu::properties::WordBreak;

let lookup = WordBreak::name_to_enum_mapper();
// short name for value
assert_eq!(lookup.get_strict("KA"), Some(WordBreak::Katakana));
assert_eq!(lookup.get_strict("LE"), Some(WordBreak::ALetter));
// long name for value
assert_eq!(lookup.get_strict("Katakana"), Some(WordBreak::Katakana));
assert_eq!(lookup.get_strict("ALetter"), Some(WordBreak::ALetter));
// name has incorrect casing
assert_eq!(lookup.get_strict("Aletter"), None);
// loose matching of name
assert_eq!(lookup.get_loose("Aletter"), Some(WordBreak::ALetter));
assert_eq!(lookup.get_loose("w_seg_space"), Some(WordBreak::WSegSpace));
// fake property
assert_eq!(lookup.get_strict("Quadruple_Quote"), None);

pub fn get_name_to_enum_mapper( provider: &(impl DataProvider<WordBreakNameToValueV1Marker> + ?Sized), ) -> Result<PropertyValueNameToEnumMapper<WordBreak>, PropertiesError>

A version of WordBreak::name_to_enum_mapper() that uses custom data provided by a DataProvider.

📚 Help choosing a constructor

pub const fn enum_to_short_name_mapper() -> PropertyEnumToValueNameLinearMapperBorrowed<'static, WordBreak>

Return a PropertyEnumToValueNameLinearMapper, capable of looking up short names for values of the Word_Break enumerated property.

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

Example

use icu::properties::WordBreak;

let lookup = WordBreak::enum_to_short_name_mapper();
assert_eq!(lookup.get(WordBreak::Katakana), Some("KA"));
assert_eq!(lookup.get(WordBreak::ALetter), Some("LE"));
assert_eq!(lookup.get(WordBreak::WSegSpace), Some("WSegSpace"));

pub fn get_enum_to_short_name_mapper( provider: &(impl DataProvider<WordBreakValueToShortNameV1Marker> + ?Sized), ) -> Result<PropertyEnumToValueNameLinearMapper<WordBreak>, PropertiesError>

A version of WordBreak::enum_to_short_name_mapper() that uses custom data provided by a DataProvider.

📚 Help choosing a constructor

pub const fn enum_to_long_name_mapper() -> PropertyEnumToValueNameLinearMapperBorrowed<'static, WordBreak>

Return a PropertyEnumToValueNameLinearMapper, capable of looking up long names for values of the Word_Break enumerated property.

✨ Enabled with the compiled_data Cargo feature.

📚 Help choosing a constructor

Example

use icu::properties::WordBreak;

let lookup = WordBreak::enum_to_long_name_mapper();
assert_eq!(lookup.get(WordBreak::Katakana), Some("Katakana"));
assert_eq!(lookup.get(WordBreak::ALetter), Some("ALetter"));
assert_eq!(lookup.get(WordBreak::WSegSpace), Some("WSegSpace"));

pub fn get_enum_to_long_name_mapper( provider: &(impl DataProvider<WordBreakValueToLongNameV1Marker> + ?Sized), ) -> Result<PropertyEnumToValueNameLinearMapper<WordBreak>, PropertiesError>

A version of WordBreak::enum_to_long_name_mapper() that uses custom data provided by a DataProvider.

📚 Help choosing a constructor

Trait Implementations

impl AsULE for WordBreak

type ULE = WordBreakULE

The ULE type corresponding to Self.

fn to_unaligned(self) -> Self::ULE

Converts from Self to Self::ULE.

fn from_unaligned(unaligned: Self::ULE) -> Self

Converts from Self::ULE to Self.

impl Clone for WordBreak

fn clone(&self) -> WordBreak

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WordBreak

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

Formats the value using the given formatter.

impl Hash for WordBreak

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 WordBreak

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

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

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

type TryFromU32Error = TryFromIntError

Last-resort fallback value to return if we cannot read data from the trie.

fn try_from_u32(i: u32) -> Result<Self, Self::TryFromU32Error>

A parsing function that is primarily motivated by deserialization contexts. When the serialization type width is smaller than 32 bits, then it is expected that the call site will widen the value to a u32 first.

fn to_u32(self) -> u32

A method for converting back to a u32 that can roundtrip through Self::try_from_u32(). The default implementation of this trait method panics in debug mode and returns 0 in release mode.

impl<'a> ZeroMapKV<'a> for WordBreak

type Container = ZeroVec<'a, WordBreak>

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

type Slice = ZeroSlice<WordBreak>

type GetType = WordBreakULE

The type produced by Container::get()

type OwnedType = WordBreak

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 WordBreak

impl Eq for WordBreak

impl StructuralPartialEq for WordBreak