Struct SelectionOwner 

#[repr(C)]
pub struct SelectionOwner {
    pub high: u64,
    pub low: u64,
}

WHO a cursor or selection belongs to (U1).

A 128-bit id rather than an index, because it has to survive a NETWORK: in a shared editing session the participants are decided elsewhere - a server, a CRDT peer id, a user account - and an engine-allocated number could not be agreed on by two machines. SelectionId is that engine-allocated number and stays local; this is the app’s, and the two are separate fields for exactly that reason.

Split into two u64s rather than a u128 because this crosses the C ABI, where u128 had no stable layout until recently and still surprises bindings.

Fields

high: u64

low: u64

Implementations

impl SelectionOwner

pub const LOCAL: Self

The person at this machine.

All-zero, so a Default selection is a local one and every existing construction site keeps meaning what it meant.

pub const SEAT_HIGH: u64 = 0x5EA7_0000_0000_0001

The high half every SEAT owner carries (9b-ii-a-i-d-ii-a). A random (v4) peer UUID never has this exact high half, and it is non-zero so a seat owner is never “local”.

pub const fn new(high: u64, low: u64) -> Self

pub const fn is_local(self) -> bool

Is this the local participant?

pub const fn seat(seat_id: u64) -> Self

The owner that stands for pointer / keyboard seat seat_id’s caret (9b-ii-a-i-d-ii-a): a second person at this machine, drawn like a peer caret in that seat’s colour. Seat 0, the primary, is LOCAL.

pub const fn is_seat(self) -> bool

Whether this owner is a (non-primary) seat at this machine.

pub const fn seat_id(self) -> Option<u64>

The seat this owner stands for, if it is one.

Trait Implementations

impl Clone for SelectionOwner

fn clone(&self) -> SelectionOwner

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SelectionOwner

impl Debug for SelectionOwner

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

Formats the value using the given formatter.

impl Default for SelectionOwner

fn default() -> SelectionOwner

Returns the “default value” for a type.

impl Eq for SelectionOwner

impl Hash for SelectionOwner

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 Ord for SelectionOwner

fn cmp(&self, other: &SelectionOwner) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for SelectionOwner

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SelectionOwner

fn partial_cmp(&self, other: &SelectionOwner) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for SelectionOwner