Enum CaretAffinity 

pub enum CaretAffinity {
    Downstream,
    Upstream,
}

Determines which logical neighbor owns a caret at a shared text boundary.

At a soft wrap, downstream places the caret at the next row’s start, and upstream places it at the previous row’s end. At a bidirectional boundary, affinities can place the same byte index at different horizontal positions. They refer to logical order, not visual left and right.

Variants

Downstream

The caret attaches to the logically following cluster.

Upstream

The caret attaches to the logically preceding cluster.

Implementations

impl CaretAffinity

pub fn for_inserted_text(text: &str) -> Self

Returns the affinity for a caret placed right after text was inserted.

Returns CaretAffinity::Downstream when text is empty or ends with a hard line break, so the caret starts the next line. Otherwise it returns CaretAffinity::Upstream.

Trait Implementations

impl Clone for CaretAffinity

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CaretAffinity

impl Debug for CaretAffinity

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

Formats the value using the given formatter.

impl Default for CaretAffinity

fn default() -> Self

Returns the “default value” for a type.

impl Eq for CaretAffinity

impl From<&str> for CaretAffinity

fn from(text: &str) -> Self

Converts to this type from the input type.

impl Hash for CaretAffinity

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 for CaretAffinity

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CaretAffinity