pub struct WebSocketState<T> { /* private fields */ }

Implementations§

source§

impl<T: Read + Write> WebSocketState<T>

source

pub fn new(socket: WebSocket<T>) -> Self

source

pub fn subscribe<'a>( &mut self, streams: impl IntoIterator<Item = &'a Stream> ) -> u64

Sends SUBSCRIBE message for the given streams.

streams are not validated. Invalid streams will be accepted by the server, but no data will be sent. Requests to subscribe an existing stream will be ignored by the server.

Returns the message id. This should be used to match the request with a future response. Sent messages should not share the same message id.

You should expect the server to respond with a similar message.

{ "method": "SUBSCRIBE", "params": [ <streams> ], "id": <id> }
source

pub fn unsubscribe<'a>( &mut self, streams: impl IntoIterator<Item = &'a Stream> ) -> u64

Sends UNSUBSCRIBE message for the given streams.

streams are not validated. Non-existing streams will be ignored by the server.

Returns the message id. This should be used to match the request with a future response. Sent messages should not share the same message id.

You should expect the server to respond with a similar message.

{ "method": "UNSUBSCRIBE", "params": [ <streams> ], "id": <id> }
source

pub fn subscriptions(&mut self) -> u64

Sends LIST_SUBSCRIPTIONS message.

Returns the message id. This should be used to match the request with a future response. Sent messages should not share the same message id.

You should expect the server to respond with a similar message.

{ "method": "LIST_SUBSCRIPTIONS", "params": [ <streams> ], "id": <id> }
source

pub fn close(self) -> Result<(), Error>

Trait Implementations§

source§

impl<T> AsMut<WebSocket<T>> for WebSocketState<T>

source§

fn as_mut(&mut self) -> &mut WebSocket<T>

Converts this type into a mutable reference of the (usually inferred) input type.
source§

impl<T> From<WebSocketState<T>> for WebSocket<T>

source§

fn from(conn: WebSocketState<T>) -> WebSocket<T>

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<T> RefUnwindSafe for WebSocketState<T>
where T: RefUnwindSafe,

§

impl<T> Send for WebSocketState<T>
where T: Send,

§

impl<T> Sync for WebSocketState<T>
where T: Sync,

§

impl<T> Unpin for WebSocketState<T>
where T: Unpin,

§

impl<T> UnwindSafe for WebSocketState<T>
where T: UnwindSafe,

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

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> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V