Struct LineBreak 

pub struct LineBreak(/* private fields */);

Enumerated property Line_Break.

See “Line Breaking Properties” in UAX #14 for the summary of each property value: https://www.unicode.org/reports/tr14/#Properties

The numeric value is compatible with ULineBreak in ICU4C.

Note: Use icu::segmenter for an all-in-one break iterator implementation.

Example

use icu::properties::{CodePointMapData, props::LineBreak};

assert_eq!(
    CodePointMapData::<LineBreak>::new().get(')'),
    LineBreak::CloseParenthesis
); // U+0029: Right Parenthesis
assert_eq!(
    CodePointMapData::<LineBreak>::new().get('ぁ'),
    LineBreak::ConditionalJapaneseStarter
); //U+3041: Hiragana Letter Small A

Implementations

impl LineBreak

pub const Unknown: Self

pub const XX: Self = Self::Unknown

pub const Ambiguous: Self

pub const AI: Self = Self::Ambiguous

pub const Alphabetic: Self

pub const AL: Self = Self::Alphabetic

pub const BreakBoth: Self

pub const B2: Self = Self::BreakBoth

pub const BreakAfter: Self

pub const BA: Self = Self::BreakAfter

pub const BreakBefore: Self

pub const BB: Self = Self::BreakBefore

pub const MandatoryBreak: Self

pub const BK: Self = Self::MandatoryBreak

pub const ContingentBreak: Self

pub const CB: Self = Self::ContingentBreak

pub const ClosePunctuation: Self

pub const CL: Self = Self::ClosePunctuation

pub const CombiningMark: Self

pub const CM: Self = Self::CombiningMark

pub const CarriageReturn: Self

pub const CR: Self = Self::CarriageReturn

pub const Exclamation: Self

pub const EX: Self = Self::Exclamation

pub const Glue: Self

pub const GL: Self = Self::Glue

pub const Hyphen: Self

pub const HY: Self = Self::Hyphen

pub const Ideographic: Self

pub const ID: Self = Self::Ideographic

pub const Inseparable: Self

pub const IN: Self = Self::Inseparable

pub const Inseperable: Self = Self::Inseparable

pub const InfixNumeric: Self

pub const IS: Self = Self::InfixNumeric

pub const LineFeed: Self

pub const LF: Self = Self::LineFeed

pub const Nonstarter: Self

pub const NS: Self = Self::Nonstarter

pub const Numeric: Self

pub const NU: Self = Self::Numeric

pub const OpenPunctuation: Self

pub const OP: Self = Self::OpenPunctuation

pub const PostfixNumeric: Self

pub const PO: Self = Self::PostfixNumeric

pub const PrefixNumeric: Self

pub const PR: Self = Self::PrefixNumeric

pub const Quotation: Self

pub const QU: Self = Self::Quotation

pub const ComplexContext: Self

pub const SA: Self = Self::ComplexContext

pub const Surrogate: Self

pub const SG: Self = Self::Surrogate

pub const Space: Self

pub const SP: Self = Self::Space

pub const BreakSymbols: Self

pub const SY: Self = Self::BreakSymbols

pub const ZWSpace: Self

pub const ZW: Self = Self::ZWSpace

pub const NextLine: Self

pub const NL: Self = Self::NextLine

pub const WordJoiner: Self

pub const WJ: Self = Self::WordJoiner

pub const H2: Self

pub const H3: Self

pub const JL: Self

pub const JT: Self

pub const JV: Self

pub const CloseParenthesis: Self

pub const CP: Self = Self::CloseParenthesis

pub const ConditionalJapaneseStarter: Self

pub const CJ: Self = Self::ConditionalJapaneseStarter

pub const HebrewLetter: Self

pub const HL: Self = Self::HebrewLetter

pub const RegionalIndicator: Self

pub const RI: Self = Self::RegionalIndicator

pub const EBase: Self

pub const EB: Self = Self::EBase

pub const EModifier: Self

pub const EM: Self = Self::EModifier

pub const ZWJ: Self

pub const Aksara: Self

pub const AK: Self = Self::Aksara

pub const AksaraPrebase: Self

pub const AP: Self = Self::AksaraPrebase

pub const AksaraStart: Self

pub const AS: Self = Self::AksaraStart

pub const ViramaFinal: Self

pub const VF: Self = Self::ViramaFinal

pub const Virama: Self

pub const VI: Self = Self::Virama

pub const UnambiguousHyphen: Self

pub const HH: Self = Self::UnambiguousHyphen

impl LineBreak

pub const ALL_VALUES: &'static [Self]

👎Deprecated

Deprecated

impl LineBreak

pub const fn to_icu4c_value(self) -> u8

👎Deprecated since 2.3.0:

please comment on https://github.com/unicode-org/icu4x/issues/6067 if you need this

Returns an ICU4C ULineBreak value.

pub const fn from_icu4c_value(value: u8) -> Self

👎Deprecated since 2.3.0:

please comment on https://github.com/unicode-org/icu4x/issues/6067 if you need this

Constructor from an ICU4C ULineBreak value.

Trait Implementations

impl AsULE for LineBreak

type ULE = u8

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 LineBreak

fn clone(&self) -> LineBreak

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LineBreak

impl Debug for LineBreak

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

Formats the value using the given formatter.

impl Default for LineBreak

fn default() -> Self

Returns the “default value” for a type.

impl EnumeratedProperty for LineBreak

const NAME: &'static [u8]

The name of this property

const SHORT_NAME: &'static [u8]

The abbreviated name of this property, if it exists, otherwise the name

fn for_char(ch: char) -> Self

Convenience method for CodePointMapData::new().get(ch)

impl Eq for LineBreak

impl From<LineBreak> for u16

fn from(other: LineBreak) -> Self

Converts to this type from the input type.

impl Hash for LineBreak

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 NamedEnumeratedProperty for LineBreak

fn try_from_str(s: &str) -> Option<Self>

Convenience method for PropertyParser::new().get_loose(s)

fn long_name(&self) -> &'static str

Convenience method for PropertyNamesLong::new().get(*self).unwrap()

fn short_name(&self) -> &'static str

Convenience method for PropertyNamesShort::new().get(*self).unwrap()

impl Ord for LineBreak

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

impl PartialEq for LineBreak

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for LineBreak

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

impl TrieValue for LineBreak

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.