typed_websocket

Struct TypedWebSocketStream

Source 
pub struct TypedWebSocketStream<S, INPUT, OUTPUT>
where
    INPUT: Serialize,
    OUTPUT: for<'de> Deserialize<'de>,
{ /* private fields */ }
Expand description

Generic WebSocket wrapper for typed OUTPUT and INPUT messages

Implementations§

Source§

impl<S, OUTPUT, INPUT> TypedWebSocketStream<S, INPUT, OUTPUT>
where S: AsyncRead + AsyncWrite + Unpin, INPUT: Serialize, OUTPUT: for<'de> Deserialize<'de>,

Source

pub fn new(stream: WebSocketStream<S>) -> Self

Create a new TypedWebSocketStream

Source

pub async fn send(&mut self, message: INPUT) -> Result<(), Box<dyn Error>>

Send a strongly-typed message

Source

pub async fn receive(&mut self) -> Result<OUTPUT, Box<dyn Error>>

Receive a strongly-typed message

Source

pub async fn close(&mut self) -> Result<(), Box<dyn Error>>

Close the WebSocket connection

Auto Trait Implementations§

§

impl<S, INPUT, OUTPUT> Freeze for TypedWebSocketStream<S, INPUT, OUTPUT>
where S: Freeze,

§

impl<S, INPUT, OUTPUT> !RefUnwindSafe for TypedWebSocketStream<S, INPUT, OUTPUT>

§

impl<S, INPUT, OUTPUT> Send for TypedWebSocketStream<S, INPUT, OUTPUT>
where INPUT: Send, OUTPUT: Send, S: Send,

§

impl<S, INPUT, OUTPUT> Sync for TypedWebSocketStream<S, INPUT, OUTPUT>
where INPUT: Sync, OUTPUT: Sync, S: Sync,

§

impl<S, INPUT, OUTPUT> Unpin for TypedWebSocketStream<S, INPUT, OUTPUT>
where INPUT: Unpin, OUTPUT: Unpin, S: Unpin,

§

impl<S, INPUT, OUTPUT> !UnwindSafe for TypedWebSocketStream<S, INPUT, OUTPUT>

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

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

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