Enum druid_shell::text::Movement[][src]

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

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)

This enum is marked as 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.

Tuple Fields of Grapheme

0: Direction
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.

Tuple Fields of Word

0: Direction
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.

Tuple Fields of Line

0: Direction
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.

Tuple Fields of Vertical

0: VerticalMovement

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

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

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Performs the conversion.

Performs the conversion.

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more