Enum MoveType

#[non_exhaustive]
pub enum MoveType {
    BufferPos(MovePosition),
    BufferByteOffset,
    BufferLineOffset,
    BufferLinePercent,
    Column(MoveDir1D, bool),
    FinalNonBlank(MoveDir1D),
    FirstWord(MoveDir1D),
    ItemMatch,
    Line(MoveDir1D),
    LineColumnOffset,
    LinePercent,
    LinePos(MovePosition),
    WordBegin(WordStyle, MoveDir1D),
    WordEnd(WordStyle, MoveDir1D),
    ParagraphBegin(MoveDir1D),
    SentenceBegin(MoveDir1D),
    SectionBegin(MoveDir1D),
    SectionEnd(MoveDir1D),
    ScreenFirstWord(MoveDir1D),
    ScreenLine(MoveDir1D),
    ScreenLinePos(MovePosition),
    ViewportPos(MovePosition),
}

Specify a movement away from the current cursor position.

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.

BufferPos(MovePosition)

Move to a line at a position relative to the buffer.

BufferByteOffset

Move to the column n bytes into the buffer.

BufferLineOffset

Move to the n^th line in the buffer.

BufferLinePercent

Move to the line n% of the way through the buffer.

Column(MoveDir1D, bool)

Move to the previous or next column n times.

The bool parameter indicates whether to cross line boundaries.

FinalNonBlank(MoveDir1D)

Move to the final non-blank character n lines away in MoveDir1D direction.

FirstWord(MoveDir1D)

Move to the first word n lines away in MoveDir1D direction.

ItemMatch

Move to the matching character of the next item.

Items are characters like (/), [/], {/}, and so on.

Line(MoveDir1D)

Move n lines in MoveDir1D direction.

LineColumnOffset

Move to the n^th column in the current line.

LinePercent

Move to the column n% of the way through the current line.

LinePos(MovePosition)

Move to a column at a position relative to the current line.

WordBegin(WordStyle, MoveDir1D)

Move to the beginning of a word n times in MoveDir1D direction.

WordEnd(WordStyle, MoveDir1D)

Move to the end of a word n times in MoveDir1D direction.

ParagraphBegin(MoveDir1D)

Move to the beginning of a paragraph n times in MoveDir1D direction.

SentenceBegin(MoveDir1D)

Move to the beginning of a sentence n times in MoveDir1D direction.

SectionBegin(MoveDir1D)

Move to the beginning of a section n times in MoveDir1D direction.

SectionEnd(MoveDir1D)

Move to the end of a section n times in MoveDir1D direction.

ScreenFirstWord(MoveDir1D)

Move to the first word of a screen line n times away in MoveDir1D direction.

ScreenLine(MoveDir1D)

Move n screen lines in MoveDir1D direction.

ScreenLinePos(MovePosition)

Move to a column at a position relative to the current screen line.

ViewportPos(MovePosition)

Move to the first word of the line displayed at a position relative to the viewport.

Implementations

impl MoveType

pub fn is_inclusive_motion(&self) -> bool

Returns true if this is an inclusive motion.

pub fn is_jumping(&self) -> bool

Returns true if this is a motion that causes cursor positions to be saved to PositionList::JumpList.

pub fn shape(&self) -> TargetShape

Returns the shape of the text selected by this movement when editing.

Trait Implementations

impl Clone for MoveType

fn clone(&self) -> MoveType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MoveType

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

Formats the value using the given formatter.

impl From<MoveType> for EditTarget

fn from(mt: MoveType) -> Self

Converts to this type from the input type.

impl PartialEq for MoveType

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for MoveType

impl StructuralPartialEq for MoveType