Skip to main content

SceneChatAlias

Struct SceneChatAlias 

Source
pub struct SceneChatAlias { /* private fields */ }
Available on crate feature websocket only.
Expand description

The "scene" switch of one connection’s ChatStreamEnable subscription, shared with that connection’s SceneStreamHandler.

While on, the handler delivers every Scene event the user may receive, as a SceneStreamEnable with regionIds and eventTypes both null would: the "scene" path “Subscribes to all Scene event types for all regions in which the user has an active avatar” (draft-atwood-jmap-scene-wss-00 §Interoperability with JMAP Chat WebSocket). That covers every SceneStreamEnable subscription without observe. An observer subscription also reaches listed regions without an avatar (“It has no observer form”, jmap-chat-spec 93f2258), so for an event the "scene" path does not admit the handler still asks the connection’s own observer subscription. Either way the union the server “MUST deliver” is decided once per event: “if an event matches both subscriptions, it is delivered exactly once” (§Subscription Union). SceneStreamDisable does not touch it, and turning it off leaves the SceneStreamEnable subscription in place (§Subscription Independence).

Set it to jmap_chat_server::EphemeralSubscription::scene after every change of the Chat subscription; jmap-chat-scene-server does.

Implementations§

Source§

impl SceneChatAlias

Source

pub fn set(&self, on: bool)

Switch the "scene" path on or off.

Source

pub fn is_on(&self) -> bool

Whether the "scene" path is on.

Trait Implementations§

Source§

impl Clone for SceneChatAlias

Source§

fn clone(&self) -> Self

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 SceneChatAlias

Source§

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

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

impl Default for SceneChatAlias

Source§

fn default() -> Self

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

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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more