Struct WordBoundary 

pub struct WordBoundary { /* private fields */ }

A TextBoundary subclass for locating word breaks.

The underlying implementation uses UAX #29 defined default word boundaries.

The default word break rules can be tailored to meet the requirements of different use cases. For instance, the default rule set keeps horizontal whitespaces together as a single word, which may not make sense in a word-counting context – “hello world” counts as 3 words instead of 2. An example is the move_by_word_boundary variant, which is a tailored word-break locator that more closely matches the default behavior of most platforms and editors when it comes to handling text editing keyboard shortcuts that move or delete word by word.

Implementations

impl WordBoundary

pub fn move_by_word_boundary(&self) -> Box<dyn TextBoundary>

Returns a TextBoundary suitable for handling keyboard navigation commands that change the current selection word by word.

This TextBoundary is used by text widgets in the flutter framework to provide default implementation for text editing shortcuts, for example, “delete to the previous word”.

The implementation applies the same set of rules WordBoundary uses, except that word breaks end on a space separator or a punctuation will be skipped, to match the behavior of most platforms. Additional rules may be added in the future to better match platform behaviors.

Trait Implementations

impl Clone for WordBoundary

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl TextBoundary for WordBoundary

fn get_text_boundary_at(&self, app: &mut App, position: i32) -> TextRange

Returns the text boundary range that encloses the input position.

fn get_leading_text_boundary_at( &self, app: &mut App, position: i32, ) -> Option<i32>

Returns the offset of the closest text boundary before or at the given position, or None if no boundaries can be found.

fn get_trailing_text_boundary_at( &self, app: &mut App, position: i32, ) -> Option<i32>

Returns the offset of the closest text boundary after the given position, or None if there is no boundary can be found after position.