Skip to main content

SelectionSet

Struct SelectionSet 

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

A selection set. Always non-empty. Index primary points at the primary selection; in v1 the set has exactly one entry and primary == 0.

The fields are private so the invariant cannot be broken: every constructor yields at least one selection and an in-range primary, so Self::primary never panics.

§Examples

use lattice_protocol::{Position, Selection, SelectionSet};

let mut set = SelectionSet::default(); // one cursor at the origin
assert_eq!(set.all().len(), 1);
assert_eq!(set.primary().head, Position::ZERO);

set.replace_primary(Selection::cursor(Position::new(3, 0)));
assert_eq!(set.primary().head.line, 3);

// Rebuilding from parts repairs what would break the invariant.
let repaired = SelectionSet::from_parts(vec![], 5);
assert_eq!(repaired, SelectionSet::cursor_at_origin());
let clamped = SelectionSet::from_parts(vec![Selection::cursor(Position::ZERO)], 5);
assert_eq!(clamped.primary_index(), 0);

Implementations§

Source§

impl SelectionSet

Source

pub fn single(selection: Selection) -> Self

A set holding just selection, which is primary.

Source

pub fn cursor_at_origin() -> Self

One plain cursor at Position::ZERO — also the Default.

Source

pub fn from_parts(selections: Vec<Selection>, primary: usize) -> Self

Reconstruct a set from its parts — the counterpart to Self::all + Self::primary_index, used to rebuild a SelectionSet that was projected into an owned form (e.g. the plugin-host WIT boundary). The non-empty invariant is preserved: an empty selections collapses to a single origin cursor, and primary is clamped into range.

Source

pub fn primary(&self) -> &Selection

The primary selection — the one single-cursor code acts on.

Source

pub fn primary_mut(&mut self) -> &mut Selection

Mutable access to the primary selection.

Source

pub fn all(&self) -> &[Selection]

Every selection, in stored order (never empty).

Source

pub fn primary_index(&self) -> usize

Index of the primary within Self::all.

Source

pub fn replace_primary(&mut self, selection: Selection)

Overwrite the primary selection in place; the others are untouched.

Trait Implementations§

Source§

impl Clone for SelectionSet

Source§

fn clone(&self) -> SelectionSet

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 Debug for SelectionSet

Source§

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

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

impl Default for SelectionSet

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for SelectionSet

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 SelectionSet

Source§

impl PartialEq for SelectionSet

Source§

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

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 SelectionSet

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

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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.