WebSocketReader

Struct WebSocketReader 

Source
pub struct WebSocketReader { /* private fields */ }
Expand description

Runner thread for a websockets connection

Implementations§

Source§

impl WebSocketReader

Source

pub fn new_unchecked(read_stream: OwnedReadHalf) -> WebSocketReader

Generates a new instance of the websocket reader, assuming the handshake has already been performed

Source

pub fn set_permit(&mut self, permit: OwnedSemaphorePermit)

Auxiliar function that cataclysm uses to keep track of connections

Source

pub async fn try_read_frame(&self) -> Result<Frame, Error>

Blocks until a message is received

Source

pub fn spawn<H: WebSocketThread + 'static>( self, wst: H, ) -> JoinHandle<<H as WebSocketThread>::Output>

Spawns a tokio thread that dispatches the message to the proved handler

Trait Implementations§

Source§

impl AsRef<TcpStream> for WebSocketReader

Source§

fn as_ref(&self) -> &TcpStream

Converts this type into a shared reference of the (usually inferred) input type.
Source§

impl From<WebSocketReader> for OwnedReadHalf

Source§

fn from(source: WebSocketReader) -> OwnedReadHalf

Converts to this type from the input type.

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