Struct icu_segmenter::SentenceSegmenter

pub struct SentenceSegmenter { /* private fields */ }

Supports loading sentence break data, and creating sentence break iterators for different string encodings.

Examples

Segment a string:

use icu_segmenter::SentenceSegmenter;
let segmenter =
    SentenceSegmenter::try_new_unstable(&icu_testdata::unstable())
        .expect("Data exists");

let breakpoints: Vec<usize> =
    segmenter.segment_str("Hello World").collect();
assert_eq!(&breakpoints, &[0, 11]);

Segment a Latin1 byte string:

use icu_segmenter::SentenceSegmenter;
let segmenter =
    SentenceSegmenter::try_new_unstable(&icu_testdata::unstable())
        .expect("Data exists");

let breakpoints: Vec<usize> =
    segmenter.segment_latin1(b"Hello World").collect();
assert_eq!(&breakpoints, &[0, 11]);

Successive boundaries can be used to retrieve the sentences. In particular, the first boundary is always 0, and the last one is the length of the segmented text in code units.

use itertools::Itertools;
let text = "Ceci tuera cela. Le livre tuera l’édifice.";
let sentences: Vec<&str> = segmenter
    .segment_str(text)
    .tuple_windows()
    .map(|(i, j)| &text[i..j])
    .collect();
assert_eq!(
    &sentences,
    &["Ceci tuera cela. ", "Le livre tuera l’édifice."]
);

Implementations

impl SentenceSegmenter

pub fn try_new_unstable<D>(provider: &D) -> Result<Self, SegmenterError>where D: DataProvider<SentenceBreakDataV1Marker> + ?Sized,

Constructs a SentenceSegmenter with an invariant locale.

pub fn try_new_with_any_provider( provider: &impl AnyProvider + ?Sized ) -> Result<Self, SegmenterError>

Creates a new instance using an AnyProvider.

For details on the behavior of this function, see: Self::try_new_unstable

📚 Help choosing a constructor

pub fn try_new_with_buffer_provider( provider: &impl BufferProvider + ?Sized ) -> Result<Self, SegmenterError>

✨ Enabled with the "serde" feature.

Creates a new instance using a BufferProvider.

For details on the behavior of this function, see: Self::try_new_unstable

📚 Help choosing a constructor

pub fn segment_str<'l, 's>( &'l self, input: &'s str ) -> SentenceBreakIteratorUtf8<'l, 's>

Creates a sentence break iterator for an str (a UTF-8 string).

There are always breakpoints at 0 and the string length, or only at 0 for the empty string.

pub fn segment_utf8<'l, 's>( &'l self, input: &'s [u8] ) -> SentenceBreakIteratorPotentiallyIllFormedUtf8<'l, 's>

Creates a sentence break iterator for a potentially ill-formed UTF8 string

Invalid characters are treated as REPLACEMENT CHARACTER

There are always breakpoints at 0 and the string length, or only at 0 for the empty string.

pub fn segment_latin1<'l, 's>( &'l self, input: &'s [u8] ) -> SentenceBreakIteratorLatin1<'l, 's>

Creates a sentence break iterator for a Latin-1 (8-bit) string.

There are always breakpoints at 0 and the string length, or only at 0 for the empty string.

pub fn segment_utf16<'l, 's>( &'l self, input: &'s [u16] ) -> SentenceBreakIteratorUtf16<'l, 's>

Creates a sentence break iterator for a UTF-16 string.

There are always breakpoints at 0 and the string length, or only at 0 for the empty string.

Trait Implementations

impl Debug for SentenceSegmenter

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

Formats the value using the given formatter.