Skip to main content

ClientHandle

Struct ClientHandle 

Source
pub struct ClientHandle {
    pub url: Value,
    pub subscriptions: Value,
    pub futures: Value,
    pub rejections: Value,
    /* private fields */
}
Expand description

Typed client handle for the ws drive loop.

The loop owns one per frame and hands it to the venue’s handle_message; venues read the four fields it exposes instead of get_value on a box. Writes to subscriptions/futures reach the live client by tag.

Fields§

§url: Value

client.url — Value::Str when the handle names a url, else Null.

§subscriptions: Value

client.subscriptions, exactly what get_value used to read.

§futures: Value

client.futures (open single-flights on this client).

§rejections: Value

client.rejections.

Implementations§

Source§

impl ClientHandle

Source

pub fn from_value(value: Value) -> ClientHandle

Source

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

Source

pub fn as_value(&self) -> Value

The Value handle the untyped generated handlers take.

Source

pub fn resolve(&self, args: &[Value]) -> Value

Source

pub fn reject(&self, args: &[Value]) -> Value

Source

pub fn send(&self, args: &[Value]) -> Value

Source

pub fn reset(&self, error: Value) -> Value

Source

pub fn on_pong(&self) -> Value

Source

pub fn as_map(&self) -> Option<&IndexMap<String, Value>>

Source

pub fn remove_subscription(&mut self, key: &Value)

delete client.subscriptions[key]: drops the live client’s entry and the handle’s snapshot entry (what remove(&mut subscriptions, key) did).

Source

pub fn add_subscription(&mut self, key: &Value, val: Value)

client.subscriptions[key] = val: writes the live client and the handle’s snapshot (what add_element_to_object(&mut subscriptions, ..) did).

Source

pub fn has_subscription(&self, key: &Value) -> bool

key in client.subscriptions, read from the handle’s snapshot.

Source

pub fn get_subscription(&self, key: &Value) -> Value

client.subscriptions[key] (Null when absent).

Source

pub fn subscription_keys(&self) -> Vec<Value>

Object.keys(client.subscriptions) (internal tags filtered).

Source

pub fn has_future(&self, key: &Value) -> bool

key in client.futures, read from the handle’s snapshot.

Source

pub fn get_future(&self, key: &Value) -> Value

client.futures[key] (Null when absent).

Source

pub fn future_keys(&self) -> Vec<Value>

Object.keys(client.futures).

Source

pub fn future(&self, args: &[Value]) -> Value

Source

pub fn reusable_future(&self, msg_hash: Value) -> Value

Trait Implementations§

Source§

impl Clone for ClientHandle

Source§

fn clone(&self) -> ClientHandle

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

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> 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> 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