Skip to main content

Sel

Struct Sel 

Source
pub struct Sel {
    pub anchor: Position,
    pub head: Position,
}
Expand description

One selection: an anchor (the fixed end) and a head (the end a motion moves). Both are inclusive char positions — anchor == head is a bare caret, and a selection with extent covers [start, end] inclusive of both.

§Units

Char columns, like hjkl_buffer::Edit and View::cursor — NOT the grapheme columns of crate::types::Pos. Mixing the two is silently wrong on multi-byte text.

§Why the engine owns the anchor

A discipline could keep its own Vec of anchors beside Editor’s secondary carets, but shift_position may DROP a caret it cannot track, and a parallel Vec would then desync: anchors and heads would pair up wrong and the next edit would land on text the user never selected. Keeping both ends in one struct, shifted together by shift_sel, makes that class of bug unrepresentable — either the whole selection survives the edit or the whole selection is dropped.

The primary selection is deliberately asymmetric: its head is View::cursor and its anchor lives in the discipline’s own state (vim’s visual_anchor in VimState, helix’s anchor in HelixState). That split predates multi-cursor and unifying it would rewrite vim’s visual mode, so it stays. Only the secondary selections live here.

Fields§

§anchor: Position

The end that stays put while a motion runs.

§head: Position

The end a motion moves; where an edit is applied.

Implementations§

Source§

impl Sel

Source

pub fn new(anchor: Position, head: Position) -> Self

A selection from anchor to head.

Source

pub fn caret(p: Position) -> Self

A zero-width selection: anchor and head on the same position.

Source

pub fn is_caret(&self) -> bool

True when the selection has no extent.

Source

pub fn start(&self) -> Position

The earlier of the two ends, in document order.

Source

pub fn end(&self) -> Position

The later of the two ends, in document order.

Trait Implementations§

Source§

impl Clone for Sel

Source§

fn clone(&self) -> Sel

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Sel

Source§

impl Debug for Sel

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Sel

Source§

impl PartialEq for Sel

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Sel

Auto Trait Implementations§

§

impl Freeze for Sel

§

impl RefUnwindSafe for Sel

§

impl Send for Sel

§

impl Sync for Sel

§

impl Unpin for Sel

§

impl UnsafeUnpin for Sel

§

impl UnwindSafe for Sel

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

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

fn in_current_span(self) -> Instrumented<Self>

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

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

fn clone_into(&self, target: &mut T)

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

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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