Struct ws_tool::codec::AsyncWsFrameCodec

source · [−]

pub struct AsyncWsFrameCodec<S: AsyncRead + AsyncWrite> {
    pub stream: S,
    pub read_state: FrameReadState,
    pub write_state: FrameWriteState,
}

Expand description

recv/send websocket frame

Fields

stream: S

underlying transport stream

read_state: FrameReadState

read state

write_state: FrameWriteState

write state

Implementations

source

impl<S: AsyncRead + AsyncWrite + Unpin> AsyncWsFrameCodec<S>

source

pub fn new(stream: S) -> Self

construct method

source

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

construct with stream and config

source

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

get mutable underlying stream

source

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

used for server side to construct a new server

source

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

used to client side to construct a new client

source

pub async fn receive(&mut self) -> Result<ReadFrame, WsError>

receive a frame

source

pub async fn send_mut<'a, P: Into<PayloadMut<'a>>>(
 &mut self,
 opcode: OpCode,
 payload: P,
 mask_payload: bool
) -> Result<(), WsError>

send mutable payload

if mask_payload is set, mask payload first

will auto fragment if auto_fragment_size > 0

source

pub async fn send<'a, P: Into<Payload<'a>>>(
 &mut self,
 opcode: OpCode,
 payload: P
) -> Result<(), WsError>

send immutable payload

will auto fragment if auto_fragment_size > 0

source

pub async fn send_read_frame(&mut self, frame: ReadFrame) -> Result<(), WsError>

send a read frame, this method will not check validation of frame and do not fragment

source

impl<R, W, S> AsyncWsFrameCodec<S> where
 R: AsyncRead + Unpin,
 W: AsyncWrite + Unpin,
 S: AsyncRead + AsyncWrite + Unpin + Split<R = R, W = W>,

source

pub fn split(self) -> (AsyncWsFrameRecv<R>, AsyncWsFrameSend<W>)

split codec to recv and send parts

Auto Trait Implementations

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

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

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

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

impl<S> UnwindSafe for AsyncWsFrameCodec<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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · 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 for T where
U: From<T>,

const: unstable · 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<T> for T

type Output = T

Should always be Self

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::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

Struct ws_tool::codec::AsyncWsFrameCodec

Fields

Implementations

impl<S: AsyncRead + AsyncWrite + Unpin> AsyncWsFrameCodec<S>

pub fn new(stream: S) -> Self

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

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

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

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

pub async fn receive(&mut self) -> Result<ReadFrame, WsError>

pub async fn send_mut<'a, P: Into<PayloadMut<'a>>>( &mut self, opcode: OpCode, payload: P, mask_payload: bool) -> Result<(), WsError>

pub async fn send<'a, P: Into<Payload<'a>>>( &mut self, opcode: OpCode, payload: P) -> Result<(), WsError>

pub async fn send_read_frame(&mut self, frame: ReadFrame) -> Result<(), WsError>

impl<R, W, S> AsyncWsFrameCodec<S> where R: AsyncRead + Unpin, W: AsyncWrite + Unpin, S: AsyncRead + AsyncWrite + Unpin + Split<R = R, W = W>,

pub fn split(self) -> (AsyncWsFrameRecv<R>, AsyncWsFrameSend<W>)

Auto Trait Implementations

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

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

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

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

impl<S> UnwindSafe for AsyncWsFrameCodec<S> where S: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

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

type Error = Infallible

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

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

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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

pub async fn send_mut<'a, P: Into<PayloadMut<'a>>>(
&mut self,
opcode: OpCode,
payload: P,
mask_payload: bool
) -> Result<(), WsError>

pub async fn send<'a, P: Into<Payload<'a>>>(
&mut self,
opcode: OpCode,
payload: P
) -> Result<(), WsError>

impl<R, W, S> AsyncWsFrameCodec<S> where
R: AsyncRead + Unpin,
W: AsyncWrite + Unpin,
S: AsyncRead + AsyncWrite + Unpin + Split<R = R, W = W>,

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

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

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

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

impl<S> UnwindSafe for AsyncWsFrameCodec<S> where
S: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

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

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,