Enum Affinity

pub enum Affinity {
    Downstream,
    Upstream,
}

The “affinity” of a cursor which is sitting exactly on a line break.

We say “cursor” here rather than “caret” because (depending on presentation) the front-end may draw a cursor even when the region is not a caret.

Variants

Downstream

The cursor should be displayed downstream of the line break. For example, if the buffer is “abcd”, and the cursor is on a line break after “ab”, it should be displayed on the second line before “cd”.

Upstream

The cursor should be displayed upstream of the line break. For example, if the buffer is “abcd”, and the cursor is on a line break after “ab”, it should be displayed on the previous line after “ab”.

Trait Implementations

impl Clone for Affinity

fn clone(&self) -> Affinity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Affinity

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

Formats the value using the given formatter.

impl Default for Affinity

fn default() -> Affinity

Returns the “default value” for a type.

impl PartialEq for Affinity

fn eq(&self, other: &Affinity) -> 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 Copy for Affinity

impl Eq for Affinity

impl StructuralPartialEq for Affinity