Struct Viewer 

pub struct Viewer {
    pub stream_id: StreamId,
    pub viewer_id: String,
    pub name: String,
    pub color: String,
    pub identity_issuer: Option<String>,
    pub identity_subject: Option<String>,
    pub avatar_url: Option<String>,
    pub cursor: Option<(f32, f32)>,
    pub client_id: Option<ClientId>,
    pub id: ViewerId,
}

Ephemeral presence: one row per viewer per stream. As a child of the framework Client, it is cascade-deleted when the browser tab disconnects, so presence auto-clears with no timers.

Fields

stream_id: StreamId

viewer_id: String

name: String

color: String

identity_issuer: Option<String>

Optional OIDC issuer for display identity enrichment. Presence and control remain available when this is absent.

identity_subject: Option<String>

Optional OIDC subject. Client-asserted display data only; never used as authorization or as the control-lock owner key.

avatar_url: Option<String>

Optional profile image URL from the identity provider.

cursor: Option<(f32, f32)>

client_id: Option<ClientId>

id: ViewerId

Implementations

impl Viewer

pub fn row_id(stream_id: &StreamId, conn: &str) -> ViewerId

One row per connection (conn = the WebSocket client id), not per viewer_id. A browser’s tabs share the persisted viewer_id but are distinct connections, so each gets its own presence row — independently cascade-cleaned on disconnect — and only the connection holding the lock drives. Closing the driving tab therefore frees its row and the survivor is reconciled the wheel.

Trait Implementations

impl AnyItem for Viewer

fn as_any(&self) -> &dyn Any

Returns self as &dyn Any for downcasting.

fn entity_type(&self) -> &'static str

Returns the entity type name (e.g., “Target”, “Scene”).

fn equals(&self, other: &dyn AnyItem) -> bool

Typed equality across erased items.

fn server_owner(&self) -> Option<&str>

Returns the current #[server_owned] field value, if this item has one.

fn bake_server_owner(&self, server_id: &str) -> Option<Arc<dyn AnyItem>>

Returns a clone of this item with the #[server_owned] field set to server_id. Returns None if this item has no #[server_owned] field.

impl Clone for Viewer

fn clone(&self) -> Viewer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Viewer

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Viewer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eventable for Viewer

const ENTITY_NAME_STATIC: &'static str = "Viewer"

Static entity type name (use entity_type() from AnyItem for instance access).

fn entity_name_static() -> &'static str

Back-compat helper for generic call sites that still expect a function.

fn ingest_buffer_policy() -> IngestBufferPolicy

Opt-in ingest buffering policy for this entity type.

fn parse(value: Value) -> Result<Arc<dyn AnyItem>, Error>

Parse JSON into this item type.

fn parse_bytes(bytes: &[u8]) -> Result<Arc<dyn AnyItem>, Error>

Parse JSON bytes into this item type. Skips the Value round-trip when callers can hand off raw bytes (~2.27× faster than the Value → from_value path on a typical entity payload).

impl IdFor<Viewer> for ViewerId

type MapKey = Arc<str>

fn map_key(&self) -> Self::MapKey

impl PartialEq for Viewer

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Viewer

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TS for Viewer

type WithoutGenerics = Viewer

If this type does not have generic parameters, then WithoutGenerics should just be Self. If the type does have generic parameters, then all generic parameters must be replaced with a dummy type, e.g ts_rs::Dummy or ().
The only requirement for these dummy types is that EXPORT_TO must be None.

type OptionInnerType = Viewer

If the implementing type is std::option::Option<T>, then this associated type is set to T. All other implementations of TS should set this type to Self instead.

fn ident(cfg: &Config) -> String

Identifier of this type, excluding generic parameters.

fn docs() -> Option<String>

JSDoc comment to describe this type in TypeScript - when TS is derived, docs are automatically read from your doc comments or #[doc = ".."] attributes

fn name(cfg: &Config) -> String

Name of this type in TypeScript, including generic parameters

fn decl_concrete(cfg: &Config) -> String

Declaration of this type using the supplied generic arguments. The resulting TypeScript definition will not be generic. For that, see TS::decl(). If this type is not generic, then this function is equivalent to TS::decl().

fn decl(cfg: &Config) -> String

Declaration of this type, e.g. type User = { user_id: number, ... }. This function will panic if the type has no declaration.

fn inline(cfg: &Config) -> String

Formats this types definition in TypeScript, e.g { user_id: number }. This function will panic if the type cannot be inlined.

fn inline_flattened(cfg: &Config) -> String

Flatten a type declaration. This function will panic if the type cannot be flattened.

fn visit_generics(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all type parameters of this type.

fn output_path() -> Option<PathBuf>

Returns the output path to where T should be exported, relative to the output directory. The returned path does not include any base directory.

fn visit_dependencies(v: &mut impl TypeVisitor)

where Self: 'static,

Iterates over all dependency of this type.

fn dependencies(cfg: &Config) -> Vec<Dependency>

where Self: 'static,

Resolves all dependencies of this type recursively.

fn export(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem. To export this type together with all of its dependencies, use TS::export_all.

fn export_all(cfg: &Config) -> Result<(), ExportError>

where Self: 'static,

Manually export this type to the filesystem, together with all of its dependencies. To export only this type, without its dependencies, use TS::export.

fn export_to_string(cfg: &Config) -> Result<String, ExportError>

where Self: 'static,

Manually generate bindings for this type, returning a String. This function does not format the output, even if the format feature is enabled.

impl WithId for Viewer

fn id(&self) -> Arc<str>

impl WithTypedId for Viewer

type Id = ViewerId

fn typed_id(&self) -> Self::Id