Skip to main content

UserPresence

Struct UserPresence 

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

User presence information for collaborative UI.

Tracks cursor position, selection, and user metadata for rendering remote user cursors.

Implementations§

Source§

impl UserPresence

Source

pub fn new(user_id: &str, user_name: &str, color: &str) -> Self

Create a new user presence.

§Arguments
  • user_id - Unique user identifier
  • user_name - Display name
  • color - Hex color for cursor (e.g., “#FF6B6B”)
Source

pub fn set_cursor(&mut self, position: usize)

Set cursor position (clears selection).

Source

pub fn set_selection(&mut self, start: usize, end: usize)

Set selection range.

Source

pub fn clear(&mut self)

Clear cursor and selection.

Source

pub fn user_id(&self) -> String

Get user ID.

Source

pub fn user_name(&self) -> String

Get user name.

Source

pub fn color(&self) -> String

Get user color.

Source

pub fn cursor(&self) -> Option<usize>

Get cursor position.

Source

pub fn selection_start(&self) -> Option<usize>

Get selection start.

Source

pub fn selection_end(&self) -> Option<usize>

Get selection end.

Source

pub fn has_selection(&self) -> bool

Check if user has a selection (not just cursor).

Source

pub fn to_json(&self) -> Result<JsValue, JsValue>

Serialize to JSON for network transmission.

Source

pub fn from_json(js: JsValue) -> Result<UserPresence, JsValue>

Deserialize from JSON.

Trait Implementations§

Source§

impl From<UserPresence> for JsValue

Source§

fn from(value: UserPresence) -> Self

Converts to this type from the input type.
Source§

impl FromWasmAbi for UserPresence

Source§

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.
Source§

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi. Read more
Source§

impl IntoWasmAbi for UserPresence

Source§

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.
Source§

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.
Source§

impl LongRefFromWasmAbi for UserPresence

Source§

type Abi = u32

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRef<UserPresence>

Same as RefFromWasmAbi::Anchor
Source§

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
Source§

impl OptionFromWasmAbi for UserPresence

Source§

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.
Source§

impl OptionIntoWasmAbi for UserPresence

Source§

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option. Read more
Source§

impl RefFromWasmAbi for UserPresence

Source§

type Abi = u32

The Wasm ABI type references to Self are recovered from.
Source§

type Anchor = RcRef<UserPresence>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.
Source§

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi. Read more
Source§

impl RefMutFromWasmAbi for UserPresence

Source§

type Abi = u32

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRefMut<UserPresence>

Same as RefFromWasmAbi::Anchor
Source§

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi
Source§

impl TryFromJsValue for UserPresence

Source§

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.
Source§

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.
Source§

impl VectorFromWasmAbi for UserPresence

Source§

impl VectorIntoWasmAbi for UserPresence

Source§

impl WasmDescribe for UserPresence

Source§

impl WasmDescribeVector for UserPresence

Source§

impl SupportsConstructor for UserPresence

Source§

impl SupportsInstanceProperty for UserPresence

Source§

impl SupportsStaticProperty for UserPresence

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> 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> ReturnWasmAbi for T
where T: IntoWasmAbi,

Source§

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi
Source§

fn return_abi(self) -> <T as ReturnWasmAbi>::Abi

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err.
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V