Enum PresencePayload 

pub enum PresencePayload {
    Pointer {
        x: f32,
        y: f32,
    },
    Caret {
        pos: usize,
    },
    Selection {
        start: usize,
        end: usize,
    },
    Typing {
        start: usize,
        end: usize,
    },
    Arrived,
    Left,
    Following {
        target: Option<String>,
    },
    Interaction(Box<SemanticInteraction>),
    Status {
        text: String,
        automatic: bool,
    },
    Availability {
        state: Availability,
        call: Option<String>,
    },
    Composing {
        composing: bool,
    },
}

Variants

Pointer

Fields

x: f32

y: f32

Caret

Fields

pos: usize

Selection

Fields

start: usize

end: usize

Typing

The local user just inserted start..end under scope key; peers render a fading “just typed” swipe (see ui::presence::PresenceCtx::record_peer_typing). Unlike Caret/Selection this is an event, published once and decayed on the receiver.

Fields

start: usize

end: usize

Arrived

Left

Following

A room-scoped, transient follow relationship announced by the authenticated sender. It is a visual presence cue only; the local Follow command remains private to the follower’s session.

Fields

target: Option<String>

Interaction(Box<SemanticInteraction>)

Truthful action/resource activity. Identity is supplied by the authenticated event envelope; this payload never describes a mouse or keyboard gesture and therefore cannot create a synthetic cursor.

Status

Short room-scoped intention. automatic distinguishes a local-model suggestion from participant-authored words; empty text clears it.

Fields

text: String

automatic: bool

Availability

How available the authenticated sender is, and the voice channel they are in, if any. Desktop presence: the shell shows it on faces and in the roster; it never reaches an app (Self::reaches_apps).

Fields

state: Availability

call: Option<String>

Composing

The sender is composing a message in the resource their key names (a channel, a direct conversation): a draft is being typed, never what it says. composing false says they stopped, so a reader who stopped typing and closed the window is not left “typing” forever. Ephemeral: a presence frame, never the record.

Fields

composing: bool

Implementations

impl PresencePayload

pub const fn reaches_apps(&self) -> bool

Whether apps receive this: everything but the desktop’s own presence (availability), which only the shell shows.

Trait Implementations

impl Clone for PresencePayload

fn clone(&self) -> PresencePayload

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PresencePayload

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

Formats the value using the given formatter.

impl PartialEq for PresencePayload

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PresencePayload