Skip to main content

WebSocketBridge

Struct WebSocketBridge 

Source
pub struct WebSocketBridge {
    pub outgoing: VecDeque<WsFrame>,
    pub incoming: VecDeque<WsFrame>,
    pub connected: bool,
    pub max_frame_size: usize,
}
Expand description

WebSocket bridge for text/binary frame framing.

Fields§

§outgoing: VecDeque<WsFrame>

Buffered outgoing frames.

§incoming: VecDeque<WsFrame>

Buffered incoming frames.

§connected: bool

Connection state.

§max_frame_size: usize

Max frame size.

Implementations§

Source§

impl WebSocketBridge

Source

pub fn new(max_frame_size: usize) -> Self

Create a new WebSocket bridge.

Source

pub fn connect(&mut self)

Connect.

Source

pub fn disconnect(&mut self)

Disconnect.

Source

pub fn send_text(&mut self, text: &str)

Send text frame.

Source

pub fn send_binary(&mut self, data: Vec<u8>)

Send binary frame.

Source

pub fn ping(&mut self, data: Vec<u8>)

Send ping.

Source

pub fn recv_frame(&mut self) -> Option<WsFrame>

Receive next frame.

Source

pub fn inject_frame(&mut self, frame: WsFrame)

Inject an incoming frame (for testing).

Source

pub fn pending_out(&self) -> usize

Number of pending outgoing frames.

Trait Implementations§

Source§

impl Debug for WebSocketBridge

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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.