Enum druid_shell::text::Movement

#[non_exhaustive]
pub enum Movement {
    Grapheme(Direction),
    Word(Direction),
    Line(Direction),
    ParagraphStart,
    ParagraphEnd,
    Vertical(VerticalMovement),
}

Indicates a movement that transforms a particular text position in a document.

These movements transform only single indices — not selections.

You’ll note that a lot of these operations are idempotent, but you can get around this by first sending a Grapheme movement. If for instance, you want a ParagraphStart that is not idempotent, you can first send Movement::Grapheme(Direction::Upstream), and then follow it with ParagraphStart.

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.

Grapheme(Direction)

A movement that stops when it reaches an extended grapheme cluster boundary.

This movement is achieved on most systems by pressing the left and right arrow keys. For more information on grapheme clusters, see Unicode Text Segmentation.

Word(Direction)

A movement that stops when it reaches a word boundary.

This movement is achieved on most systems by pressing the left and right arrow keys while holding control. For more information on words, see Unicode Text Segmentation.

Line(Direction)

A movement that stops when it reaches a soft line break.

This movement is achieved on macOS by pressing the left and right arrow keys while holding command. Line should be idempotent: if the position is already at the end of a soft-wrapped line, this movement should never push it onto another soft-wrapped line.

In order to implement this properly, your text positions should remember their affinity.

ParagraphStart

An upstream movement that stops when it reaches a hard line break.

ParagraphStart should be idempotent: if the position is already at the start of a hard-wrapped line, this movement should never push it onto the previous line.

ParagraphEnd

A downstream movement that stops when it reaches a hard line break.

ParagraphEnd should be idempotent: if the position is already at the end of a hard-wrapped line, this movement should never push it onto the next line.

Vertical(VerticalMovement)

A vertical movement, see VerticalMovement for more details.

Trait Implementations

impl Clone for Movement

fn clone(&self) -> Movement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Movement

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

Formats the value using the given formatter.

impl Hash for Movement

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 PartialEq<Movement> for Movement

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Movement

impl Eq for Movement

impl StructuralEq for Movement

impl StructuralPartialEq for Movement