Skip to main content

WebRoom

Struct WebRoom 

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

A live web room for page sharing. WebRoom wraps Room and carries presence and small DOM mutations. Initial HTML and media bytes travel over HTTP bootstrap/asset routes, not this socket.

Implementations§

Source§

impl WebRoom

Source

pub fn set_hooks(&self, hooks: Arc<dyn WebRoomHooks>)

Source

pub fn from_parent( parent: &Room, hooks: Option<Arc<dyn WebRoomHooks>>, connection_state: &Value, ) -> WebRoom

Ingest-only child of a MachineRoom (same socket).

Source

pub fn get_host_principal(&self) -> Option<String>

Host principal tagged string, if the connection provided it.

Source

pub fn can_invite(&self) -> bool

Whether this signed-in caller may invite others (server-gated).

Source

pub fn get_snapshot(&self) -> Option<WebSnapshot>

Source

pub fn get_bootstrap(&self) -> Option<BootstrapMeta>

Source

pub fn disconnect(&self)

Source

pub fn ingest_snapshot(&self, snapshot: WebSnapshot)

Source

pub fn ingest_bootstrap(&self, meta: BootstrapMeta)

Source

pub fn publish_bootstrap(&self, meta: BootstrapMeta)

Source

pub fn publish_snapshot(&self, snapshot: WebSnapshot)

Source

pub fn publish_mutation(&self, mutation: &WebMutation)

Source

pub fn publish_closed(&self)

Source

pub fn set_tool_handler( &self, handler: WebToolHandler, ) -> Box<dyn FnOnce() + Send + Sync>

Host: fulfill inbound web-tool-call frames. Returns a function that removes the handler.

Source

pub async fn invoke_tool( &self, name: &str, params: Map<String, Value>, timeout_ms: Option<u64>, ) -> Result<String>

Any member: ask the host to run a page tool. Times out after timeout_ms (30 seconds by default).

Source

pub fn handle_event(&self, packet: &Value) -> bool

Methods from Deref<Target = Room>§

Source

pub fn endpoint(&self) -> &str

Source

pub fn ws(&self) -> RoomSocket

Source

pub fn authorization(&self) -> &Authorization

Source

pub fn id(&self) -> &str

Source

pub fn get_presences(&self) -> Vec<Presence>

Source

pub fn get_authorization(&self) -> &CredentialsOrApiKey

The caller’s Credentials or ApiKey from the live authorization pack.

Source

pub fn post(&self, packet: &Value)

Source

pub fn disconnect(&self)

Source

pub async fn generate_access_code(&self) -> Result<String>

Trait Implementations§

Source§

impl Clone for WebRoom

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 Deref for WebRoom

Source§

type Target = Room

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Room

Dereferences the value.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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