Struct rust_icu_ubrk::UBreakIterator
source · pub struct UBreakIterator { /* private fields */ }
Expand description
Rust wrapper for the ICU UBreakIterator
type.
Implementations§
source§impl UBreakIterator
impl UBreakIterator
sourcepub fn available_locales() -> Locales ⓘ
pub fn available_locales() -> Locales ⓘ
Returns an iterator over the locales for which text breaking information is available.
Implements ubrk_countAvailable
.
sourcepub fn try_new(
type_: UBreakIteratorType,
locale: &str,
text: &str
) -> Result<Self, Error>
pub fn try_new( type_: UBreakIteratorType, locale: &str, text: &str ) -> Result<Self, Error>
Creates a new break iterator with the specified type (character, word,
line, or sentence) in the specified locale over text
.
Implements ubrk_open
.
sourcepub fn try_new_ustring(
type_: UBreakIteratorType,
locale: &ULoc,
text: &UChar
) -> Result<Self, Error>
pub fn try_new_ustring( type_: UBreakIteratorType, locale: &ULoc, text: &UChar ) -> Result<Self, Error>
Implements ubrk_open
.
sourcepub fn try_new_rules(rules: &str, text: &str) -> Result<Self, Error>
pub fn try_new_rules(rules: &str, text: &str) -> Result<Self, Error>
Creates a new break iterator using the specified breaking rules.
See the ICU user guide for rules syntax.
Implements ubrk_openRules
.
sourcepub fn try_new_rules_ustring(rules: &UChar, text: &UChar) -> Result<Self, Error>
pub fn try_new_rules_ustring(rules: &UChar, text: &UChar) -> Result<Self, Error>
Implements ubrk_openRules
.
sourcepub fn try_new_binary_rules(rules: &Vec<u8>, text: &str) -> Result<Self, Error>
pub fn try_new_binary_rules(rules: &Vec<u8>, text: &str) -> Result<Self, Error>
Creates a new break iterator using pre-compiled binary rules.
Binary rules can be obtained with get_binary_rules
.
Implements ubrk_openBinaryRules
.
sourcepub fn try_new_binary_rules_ustring(
rules: &Vec<u8>,
text: &UChar
) -> Result<Self, Error>
pub fn try_new_binary_rules_ustring( rules: &Vec<u8>, text: &UChar ) -> Result<Self, Error>
Implements ubrk_openBinaryRules
.
sourcepub fn get_binary_rules(&self) -> Result<Vec<u8>, Error>
pub fn get_binary_rules(&self) -> Result<Vec<u8>, Error>
Returns a Vec<u8>
containing the compiled binary version of the rules
specifying the behavior of this break iterator.
Implements ubrk_getBinaryRules
.
sourcepub fn safe_clone(&self) -> Result<Self, Error>
pub fn safe_clone(&self) -> Result<Self, Error>
Performs a clone of the underlying representation.
The cloned break iterator will hold pointers to the same text, and rules,
binary rules, or locale, as the original break iterator. The clone’s
underlying C representation will maintain its own independent iteration
state, but it will be initialized to that of the original (so, for example,
if self.current() == 11
, then self.safe_clone().current() == 11
).
Note that the Clone
trait was not implemented as the underlying operation
may fail.
Implements ubrk_safeClone
.
sourcepub fn set_text(&mut self, text: &str) -> Result<(), Error>
pub fn set_text(&mut self, text: &str) -> Result<(), Error>
Instructs this break iterator to point to a new piece of text.
Implements ubrk_setText
.
sourcepub fn current(&self) -> i32
pub fn current(&self) -> i32
Reports the most recently-returned text boundary.
Implements ubrk_current
.
sourcepub fn previous(&self) -> Option<i32>
pub fn previous(&self) -> Option<i32>
Sets the break iterator’s position to the boundary preceeding its current position.
Implements ubrk_previous
.
sourcepub fn first(&self) -> i32
pub fn first(&self) -> i32
Moves the iterator to the beginning of its text and returns the new position (zero).
Implements ubrk_first
.
sourcepub fn last_boundary(&self) -> i32
pub fn last_boundary(&self) -> i32
Moves the iterator to the position immediately beyond the last character in its text and returns the new position.
Named as such so as to avoid conflict with the last
method provided by
Iterator
.
Implements ubrk_last
.
sourcepub fn preceding(&self, offset: i32) -> i32
pub fn preceding(&self, offset: i32) -> i32
Moves the iterator to the boundary immediately preceding the specified offset and returns the new position.
Implements ubrk_preceding
.
sourcepub fn following(&self, offset: i32) -> i32
pub fn following(&self, offset: i32) -> i32
Moves the iterator to the boundary immediately following the specified offset and returns the new position.
Implements ubrk_following
.
sourcepub fn is_boundary(&self, offset: i32) -> bool
pub fn is_boundary(&self, offset: i32) -> bool
Reports whether the specified offset is a boundary.
Implements ubrk_isBoundary
.
sourcepub fn get_locale_by_type(
&self,
type_: ULocDataLocaleType
) -> Result<String, Error>
pub fn get_locale_by_type( &self, type_: ULocDataLocaleType ) -> Result<String, Error>
Returns the locale, valid or actual, of this break iterator.
Implements ubrk_getLocaleByType
.
sourcepub fn get_rule_status(&self) -> i32
pub fn get_rule_status(&self) -> i32
Returns the status of the break rule that determined the most-recently returned boundary. The default status for rules that do not explicitly provide one is zero.
See the ICU user guide for details on rule syntax and rule status values.
Implements ubrk_getRuleStatus
.
sourcepub fn get_rule_status_vec(&self) -> Result<Vec<i32>, Error>
pub fn get_rule_status_vec(&self) -> Result<Vec<i32>, Error>
Returns the statuses of the break rules that determined the most-recently returned boundary. The default status for rules that do not explicitly provide one is zero.
See the ICU user guide for details on rule syntax and rule status values.
Implements ubrk_getRuleStatusVec
.
Trait Implementations§
source§impl Iterator for UBreakIterator
impl Iterator for UBreakIterator
source§fn next(&mut self) -> Option<Self::Item>
fn next(&mut self) -> Option<Self::Item>
Advances the break iterator’s position to the next boundary after its current position.
Note that ubrk_next
will never return the first boundary. For example,
given a newly-initialized break iterator whose internal position is 0
,
the first invocation of next
will return the next boundary, not 0
.
If the caller requires the first boundary, it should utilize first
.
Also note that interleaving calls to first
, last_boundary
, previous
,
preceding
, or following
may change the break iterator’s internal
position, thereby affecting the next value returned by next
.
Implements ubrk_next
.
source§fn next_chunk<const N: usize>(
&mut self
) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>where
Self: Sized,
fn next_chunk<const N: usize>(
&mut self
) -> Result<[Self::Item; N], IntoIter<Self::Item, N>>where
Self: Sized,
iter_next_chunk
)N
values. Read more1.0.0 · source§fn size_hint(&self) -> (usize, Option<usize>)
fn size_hint(&self) -> (usize, Option<usize>)
1.0.0 · source§fn count(self) -> usizewhere
Self: Sized,
fn count(self) -> usizewhere
Self: Sized,
1.0.0 · source§fn last(self) -> Option<Self::Item>where
Self: Sized,
fn last(self) -> Option<Self::Item>where
Self: Sized,
source§fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>
fn advance_by(&mut self, n: usize) -> Result<(), NonZero<usize>>
iter_advance_by
)n
elements. Read more1.0.0 · source§fn nth(&mut self, n: usize) -> Option<Self::Item>
fn nth(&mut self, n: usize) -> Option<Self::Item>
n
th element of the iterator. Read more1.28.0 · source§fn step_by(self, step: usize) -> StepBy<Self>where
Self: Sized,
fn step_by(self, step: usize) -> StepBy<Self>where
Self: Sized,
1.0.0 · source§fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>
fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter>
1.0.0 · source§fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>where
Self: Sized,
U: IntoIterator,
fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter>where
Self: Sized,
U: IntoIterator,
source§fn intersperse(self, separator: Self::Item) -> Intersperse<Self>
fn intersperse(self, separator: Self::Item) -> Intersperse<Self>
iter_intersperse
)separator
between adjacent
items of the original iterator. Read moresource§fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>
fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>
iter_intersperse
)separator
between adjacent items of the original iterator. Read more1.0.0 · source§fn map<B, F>(self, f: F) -> Map<Self, F>
fn map<B, F>(self, f: F) -> Map<Self, F>
1.0.0 · source§fn filter<P>(self, predicate: P) -> Filter<Self, P>
fn filter<P>(self, predicate: P) -> Filter<Self, P>
1.0.0 · source§fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>
fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>
1.0.0 · source§fn enumerate(self) -> Enumerate<Self>where
Self: Sized,
fn enumerate(self) -> Enumerate<Self>where
Self: Sized,
1.0.0 · source§fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
1.0.0 · source§fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>
fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>
1.57.0 · source§fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>
fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>
1.0.0 · source§fn skip(self, n: usize) -> Skip<Self>where
Self: Sized,
fn skip(self, n: usize) -> Skip<Self>where
Self: Sized,
n
elements. Read more1.0.0 · source§fn take(self, n: usize) -> Take<Self>where
Self: Sized,
fn take(self, n: usize) -> Take<Self>where
Self: Sized,
n
elements, or fewer
if the underlying iterator ends sooner. Read more1.0.0 · source§fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>
fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>
source§fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>
fn map_windows<F, R, const N: usize>(self, f: F) -> MapWindows<Self, F, N>
iter_map_windows
)f
for each contiguous window of size N
over
self
and returns an iterator over the outputs of f
. Like slice::windows()
,
the windows during mapping overlap as well. Read more1.0.0 · source§fn inspect<F>(self, f: F) -> Inspect<Self, F>
fn inspect<F>(self, f: F) -> Inspect<Self, F>
1.0.0 · source§fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
fn by_ref(&mut self) -> &mut Selfwhere
Self: Sized,
source§fn collect_into<E>(self, collection: &mut E) -> &mut E
fn collect_into<E>(self, collection: &mut E) -> &mut E
iter_collect_into
)1.0.0 · source§fn partition<B, F>(self, f: F) -> (B, B)
fn partition<B, F>(self, f: F) -> (B, B)
source§fn is_partitioned<P>(self, predicate: P) -> bool
fn is_partitioned<P>(self, predicate: P) -> bool
iter_is_partitioned
)true
precede all those that return false
. Read more1.27.0 · source§fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R
fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R
1.27.0 · source§fn try_for_each<F, R>(&mut self, f: F) -> R
fn try_for_each<F, R>(&mut self, f: F) -> R
1.0.0 · source§fn fold<B, F>(self, init: B, f: F) -> B
fn fold<B, F>(self, init: B, f: F) -> B
1.51.0 · source§fn reduce<F>(self, f: F) -> Option<Self::Item>
fn reduce<F>(self, f: F) -> Option<Self::Item>
source§fn try_reduce<F, R>(
&mut self,
f: F
) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryType
fn try_reduce<F, R>( &mut self, f: F ) -> <<R as Try>::Residual as Residual<Option<<R as Try>::Output>>>::TryType
iterator_try_reduce
)1.0.0 · source§fn all<F>(&mut self, f: F) -> bool
fn all<F>(&mut self, f: F) -> bool
1.0.0 · source§fn any<F>(&mut self, f: F) -> bool
fn any<F>(&mut self, f: F) -> bool
1.0.0 · source§fn find<P>(&mut self, predicate: P) -> Option<Self::Item>
fn find<P>(&mut self, predicate: P) -> Option<Self::Item>
1.30.0 · source§fn find_map<B, F>(&mut self, f: F) -> Option<B>
fn find_map<B, F>(&mut self, f: F) -> Option<B>
source§fn try_find<F, R>(
&mut self,
f: F
) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType
fn try_find<F, R>( &mut self, f: F ) -> <<R as Try>::Residual as Residual<Option<Self::Item>>>::TryType
try_find
)1.0.0 · source§fn position<P>(&mut self, predicate: P) -> Option<usize>
fn position<P>(&mut self, predicate: P) -> Option<usize>
1.0.0 · source§fn max(self) -> Option<Self::Item>
fn max(self) -> Option<Self::Item>
1.0.0 · source§fn min(self) -> Option<Self::Item>
fn min(self) -> Option<Self::Item>
1.6.0 · source§fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>
fn max_by_key<B, F>(self, f: F) -> Option<Self::Item>
1.15.0 · source§fn max_by<F>(self, compare: F) -> Option<Self::Item>
fn max_by<F>(self, compare: F) -> Option<Self::Item>
1.6.0 · source§fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>
fn min_by_key<B, F>(self, f: F) -> Option<Self::Item>
1.15.0 · source§fn min_by<F>(self, compare: F) -> Option<Self::Item>
fn min_by<F>(self, compare: F) -> Option<Self::Item>
1.0.0 · source§fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)
fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)
1.36.0 · source§fn copied<'a, T>(self) -> Copied<Self>
fn copied<'a, T>(self) -> Copied<Self>
source§fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>where
Self: Sized,
fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>where
Self: Sized,
iter_array_chunks
)N
elements of the iterator at a time. Read more1.11.0 · source§fn product<P>(self) -> P
fn product<P>(self) -> P
source§fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering
fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering
iter_order_by
)Iterator
with those
of another with respect to the specified comparison function. Read more1.5.0 · source§fn partial_cmp<I>(self, other: I) -> Option<Ordering>
fn partial_cmp<I>(self, other: I) -> Option<Ordering>
PartialOrd
elements of
this Iterator
with those of another. The comparison works like short-circuit
evaluation, returning a result without comparing the remaining elements.
As soon as an order can be determined, the evaluation stops and a result is returned. Read moresource§fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>where
Self: Sized,
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,
fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>where
Self: Sized,
I: IntoIterator,
F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,
iter_order_by
)Iterator
with those
of another with respect to the specified comparison function. Read moresource§fn eq_by<I, F>(self, other: I, eq: F) -> bool
fn eq_by<I, F>(self, other: I, eq: F) -> bool
iter_order_by
)1.5.0 · source§fn lt<I>(self, other: I) -> bool
fn lt<I>(self, other: I) -> bool
Iterator
are lexicographically
less than those of another. Read more1.5.0 · source§fn le<I>(self, other: I) -> bool
fn le<I>(self, other: I) -> bool
Iterator
are lexicographically
less or equal to those of another. Read more1.5.0 · source§fn gt<I>(self, other: I) -> bool
fn gt<I>(self, other: I) -> bool
Iterator
are lexicographically
greater than those of another. Read more1.5.0 · source§fn ge<I>(self, other: I) -> bool
fn ge<I>(self, other: I) -> bool
Iterator
are lexicographically
greater than or equal to those of another. Read moresource§fn is_sorted(self) -> bool
fn is_sorted(self) -> bool
is_sorted
)source§fn is_sorted_by<F>(self, compare: F) -> bool
fn is_sorted_by<F>(self, compare: F) -> bool
is_sorted
)source§fn is_sorted_by_key<F, K>(self, f: F) -> bool
fn is_sorted_by_key<F, K>(self, f: F) -> bool
is_sorted
)