Struct WebShareHandle 

pub struct WebShareHandle { /* private fields */ }

A share handle returned by a create operation.

Dropping this handle does not stop the daemon-side share. The share remains active until its TTL expires, the shared pane or session goes away, or Self::stop is called explicitly.

Cloned handles point at the same daemon share. Stopping one clone invalidates the share for every other clone.

Implementations

impl WebShareHandle

pub fn id(&self) -> &str

Returns the opaque share id.

pub const fn scope(&self) -> &WebShareScope

Returns the pane or session scope resolved by the daemon at create time.

pub fn pane_target(&self) -> Option<&PaneTargetRef>

Returns the pane target when this is a single-pane share.

pub const fn operator(&self) -> bool

Returns whether this share minted an operator URL.

pub const fn spectator(&self) -> bool

Returns whether this share minted a spectator URL.

pub const fn kill_session_on_expire(&self) -> bool

Returns whether this share kills its target session on expiry.

pub fn spectator_url(&self) -> Option<&str>

Returns the spectator browser URL.

pub fn spectator_token(&self) -> Option<&str>

Returns the spectator capability token carried in the browser URL, when present.

pub fn operator_url(&self) -> Option<&str>

Returns the privileged operator URL, when this share has an operator.

pub fn operator_token(&self) -> Option<&str>

Returns the operator capability token carried in the operator URL, when present.

pub fn operator_pairing_code(&self) -> Option<&str>

Returns the out-of-band operator pairing code required by this share.

pub fn spectator_pairing_code(&self) -> Option<&str>

Returns the out-of-band spectator pairing code required by this share.

pub const fn max_spectators(&self) -> Option<u16>

Returns the effective cap for concurrent spectator clients, when capped.

pub const fn max_operators(&self) -> Option<u16>

Returns the effective cap for concurrent operator clients, when capped.

pub const fn expires_at_unix(&self) -> Option<u64>

Returns the expiration timestamp in UNIX seconds.

pub async fn summary(&self) -> Result<WebShareSummary>

Fetches redacted live metadata for this share.

pub async fn spectators_active(&self) -> Result<u16>

Returns the current number of spectator clients.

pub async fn operators_active(&self) -> Result<u16>

Returns the current number of operator clients.

pub async fn stop(self) -> Result<()>

Stops this share on the daemon.

Trait Implementations

impl Clone for WebShareHandle

fn clone(&self) -> WebShareHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.