Skip to main content

Cursors

Struct Cursors 

Source
pub struct Cursors { /* private fields */ }
Expand description

The editor’s cursor state — the single typed home for “where the caret(s) are”.

Phase 1 (today): holds exactly one primary Position. The mutation surface (primary / set_primary / map_primary) is the same shape a single bare Position had, so callers route through it without behavioral change — but now there is ONE typed place that owns cursor state instead of a loose Position field beside an unused multi-caret Selection. That removes the dual-source-of-truth that would desync the moment multi-cursor lands.

Phase 2 (later): the inner representation grows to { primary: Position, secondaries: Vec<Position> } (or wraps Selection directly). Because every caller already goes through this newtype’s surface, that growth is a localized change here — not a fleet-wide rewrite of self.cursor.line reads.

Implementations§

Source§

impl Cursors

Source

pub const fn single(p: Position) -> Self

One cursor at p.

Source

pub const fn primary(&self) -> Position

The primary caret position — the single read accessor every renderer and motion path uses.

Source

pub const fn set_primary(&mut self, p: Position)

Move the primary caret to p. The single write path — set_cursor in the runtime routes here, keeping clamp + viewport-follow as the only way the cursor changes.

Source

pub fn map_primary(&mut self, f: impl FnOnce(Position) -> Position)

Transform the primary caret in place.

Source

pub const fn count(&self) -> usize

Number of carets — always 1 in phase 1; the seam multi-cursor grows at.

Trait Implementations§

Source§

impl Clone for Cursors

Source§

fn clone(&self) -> Cursors

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 Cursors

Source§

impl Debug for Cursors

Source§

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

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

impl Default for Cursors

Source§

fn default() -> Cursors

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Cursors

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for Cursors

Source§

impl From<Position> for Cursors

Source§

fn from(p: Position) -> Self

Converts to this type from the input type.
Source§

impl JsonSchema for Cursors

Source§

fn schema_name() -> String

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for Cursors

Source§

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

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

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

Inequality operator !=. Read more
Source§

impl Serialize for Cursors

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Cursors

Auto Trait Implementations§

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<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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.