Enum UnicodeBreakType

#[non_exhaustive]
pub enum UnicodeBreakType {
    Mandatory,
    CarriageReturn,
    LineFeed,
    CombiningMark,
    Surrogate,
    ZeroWidthSpace,
    Inseparable,
    NonBreakingGlue,
    Contingent,
    Space,
    After,
    Before,
    BeforeAndAfter,
    Hyphen,
    NonStarter,
    OpenPunctuation,
    ClosePunctuation,
    Quotation,
    Exclamation,
    Ideographic,
    Numeric,
    InfixSeparator,
    Symbol,
    Alphabetic,
    Prefix,
    Postfix,
    ComplexContext,
    Ambiguous,
    Unknown,
    NextLine,
    WordJoiner,
    HangulLJamo,
    HangulVJamo,
    HangulTJamo,
    HangulLvSyllable,
    HangulLvtSyllable,
    CloseParenthesis,
    ConditionalJapaneseStarter,
    HebrewLetter,
    RegionalIndicator,
    EmojiBase,
    EmojiModifier,
    ZeroWidthJoiner,
    Aksara,
    AksaraPreBase,
    AksaraStart,
    ViramaFinal,
    Virama,
}

These are the possible line break classifications.

Since new Unicode versions may add new types here, applications should be ready to handle unknown values. They may be regarded as Unknown.

See Unicode Line Breaking Algorithm.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Mandatory

Mandatory Break (BK)

CarriageReturn

Carriage Return (CR)

LineFeed

Line Feed (LF)

CombiningMark

Attached Characters and Combining Marks (CM)

Surrogate

Surrogates (SG)

ZeroWidthSpace

Zero Width Space (ZW)

Inseparable

Inseparable (IN)

NonBreakingGlue

Non-breaking (“Glue”) (GL)

Contingent

Contingent Break Opportunity (CB)

Space

Space (SP)

After

Break Opportunity After (BA)

Before

Break Opportunity Before (BB)

BeforeAndAfter

Break Opportunity Before and After (B2)

Hyphen

Hyphen (HY)

NonStarter

Nonstarter (NS)

OpenPunctuation

Opening Punctuation (OP)

ClosePunctuation

Closing Punctuation (CL)

Quotation

Ambiguous Quotation (QU)

Exclamation

Exclamation/Interrogation (EX)

Ideographic

Ideographic (ID)

Numeric

Numeric (NU)

InfixSeparator

Infix Separator (Numeric) (IS)

Symbol

Symbols Allowing Break After (SY)

Alphabetic

Ordinary Alphabetic and Symbol Characters (AL)

Prefix

Prefix (Numeric) (PR)

Postfix

Postfix (Numeric) (PO)

ComplexContext

Complex Content Dependent (South East Asian) (SA)

Ambiguous

Ambiguous (Alphabetic or Ideographic) (AI)

Unknown

Unknown (XX)

NextLine

Next Line (NL)

WordJoiner

Word Joiner (WJ)

HangulLJamo

Hangul L Jamo (JL)

HangulVJamo

Hangul V Jamo (JV)

HangulTJamo

Hangul T Jamo (JT)

HangulLvSyllable

Hangul LV Syllable (H2)

HangulLvtSyllable

Hangul LVT Syllable (H3)

CloseParenthesis

Closing Parenthesis (CP). Since 2.70

ConditionalJapaneseStarter

Conditional Japanese Starter (CJ). Since: 2.32

HebrewLetter

Hebrew Letter (HL). Since: 2.32

RegionalIndicator

Regional Indicator (RI). Since: 2.36

EmojiBase

Emoji Base (EB). Since: 2.50

EmojiModifier

Emoji Modifier (EM). Since: 2.50

ZeroWidthJoiner

Zero Width Joiner (ZWJ). Since: 2.50

Aksara

Available on crate feature v2_80 only.

Aksara (AK). Since: 2.80 @G_UNICODE_BREAK_AKSARA_PRE_BASE (AP). Since: 2.80 @G_UNICODE_BREAK_AKSARA_START (AS). Since: 2.80 @G_UNICODE_BREAK_VIRAMA_FINAL (VF). Since: 2.80 @G_UNICODE_BREAK_VIRAMA (VI). Since: 2.80

AksaraPreBase

Available on crate feature v2_80 only.

AksaraStart

Available on crate feature v2_80 only.

ViramaFinal

Available on crate feature v2_80 only.

Virama

Available on crate feature v2_80 only.

Trait Implementations

impl Clone for UnicodeBreakType

fn clone(&self) -> UnicodeBreakType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnicodeBreakType

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

Formats the value using the given formatter.

impl From<UnicodeBreakType> for Value

fn from(v: UnicodeBreakType) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for UnicodeBreakType

type Checker = GenericValueTypeChecker<UnicodeBreakType>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl HasParamSpec for UnicodeBreakType

type ParamSpec = ParamSpecEnum

type SetValue = UnicodeBreakType

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str, _: UnicodeBreakType) -> ParamSpecEnumBuilder<'_, UnicodeBreakType>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for UnicodeBreakType

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 UnicodeBreakType

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

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

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

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for UnicodeBreakType

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ValueType for UnicodeBreakType

type Type = UnicodeBreakType

Type to get the Type from.

impl Copy for UnicodeBreakType

impl Eq for UnicodeBreakType

impl StructuralPartialEq for UnicodeBreakType