Struct websocket::sender::Writer

source ·
pub struct Writer<W> {
    pub stream: W,
    pub sender: Sender,
}
Expand description

A writer that bundles a stream with a serializer to send the messages. This is used in the client’s .split() function as the writing component.

It can also be useful to use a websocket connection without a handshake.

Fields§

§stream: W

The stream that websocket messages will be written to

§sender: Sender

The serializer that will be used to serialize the messages

Implementations§

source§

impl<W> Writer<W>
where W: Write,

source

pub fn send_dataframe<D>(&mut self, dataframe: &D) -> WebSocketResult<()>
where D: DataFrame, W: Write,

Sends a single data frame to the remote endpoint.

source

pub fn send_message<M>(&mut self, message: &M) -> WebSocketResult<()>
where M: Message,

Sends a single message to the remote endpoint.

source§

impl<S> Writer<S>
where S: AsTcpStream + Write,

source

pub fn shutdown(&self) -> IoResult<()>

Closes the sender side of the connection, will cause all pending and future IO to return immediately with an appropriate value.

source

pub fn shutdown_all(&self) -> IoResult<()>

Shuts down both Sender and Receiver, will cause all pending and future IO to return immediately with an appropriate value.

Auto Trait Implementations§

§

impl<W> Freeze for Writer<W>
where W: Freeze,

§

impl<W> RefUnwindSafe for Writer<W>
where W: RefUnwindSafe,

§

impl<W> Send for Writer<W>
where W: Send,

§

impl<W> Sync for Writer<W>
where W: Sync,

§

impl<W> Unpin for Writer<W>
where W: Unpin,

§

impl<W> UnwindSafe for Writer<W>
where W: 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.
source§

impl<T> Typeable for T
where T: Any,

source§

fn get_type(&self) -> TypeId

Get the TypeId of this object.