Struct ws_tool::codec::BytesCodec

source ·
pub struct BytesCodec<S: Read + Write> { /* private fields */ }
Expand description

recv/send bytes message

Implementations§

source§

impl<S: Read + Write> BytesCodec<S>

source

pub fn new(stream: S) -> Self

construct method

source

pub fn new_with(stream: S, config: FrameConfig) -> Self

construct with stream & config

source

pub fn factory(_req: Request<()>, stream: S) -> Result<Self, WsError>

used for server side to construct a new server

source

pub fn check_fn( key: String, resp: Response<()>, stream: S ) -> Result<Self, WsError>

used to client side to construct a new client

source

pub fn stream_mut(&mut self) -> &mut S

get mutable underlying stream

source

pub fn receive(&mut self) -> Result<Message<Cow<'_, [u8]>>, WsError>

receive a message

source

pub fn ping<'a>(&mut self, msg: &'a [u8]) -> Result<(), WsError>

helper method to send ping message

source

pub fn pong<'a>(&mut self, msg: &'a [u8]) -> Result<(), WsError>

helper method to send pong message

source

pub fn close<'a>(&mut self, code: u16, msg: &'a [u8]) -> Result<(), WsError>

helper method to send close message

source

pub fn send<'a, T: Into<Message<Cow<'a, [u8]>>>>( &mut self, msg: T ) -> Result<(), WsError>

send a message

source

pub fn flush(&mut self) -> Result<(), WsError>

flush underlying stream

source§

impl<R, W, S> BytesCodec<S>
where R: Read, W: Write, S: Read + Write + Split<R = R, W = W>,

source

pub fn split(self) -> (BytesRecv<R>, BytesSend<W>)

split codec to recv and send parts

Auto Trait Implementations§

§

impl<S> RefUnwindSafe for BytesCodec<S>
where S: RefUnwindSafe,

§

impl<S> Send for BytesCodec<S>
where S: Send,

§

impl<S> Sync for BytesCodec<S>
where S: Sync,

§

impl<S> Unpin for BytesCodec<S>
where S: Unpin,

§

impl<S> UnwindSafe for BytesCodec<S>
where S: 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> 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> 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

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