Struct Websocket

Source
pub struct Websocket<S> { /* private fields */ }

Implementations§

Source§

impl<S> Websocket<S>
where S: AsyncRead + AsyncWrite + Unpin + Send + 'static,

Source

pub fn new(stream: S) -> Self

Create a new websocket instance, given any type that implements AsyncRead + AsyncWrite like tokio::net::TcpStream or tokio_native_tls::TlsStream

Source

pub fn new_with_key(stream: S, key: String) -> Self

Same as Websocket::new except that it also accept a key that represent the value of Sec-Websocket-Key for client that requires a valid Sec-Websocket-Accept in response headers.

Source

pub async fn next(&mut self) -> Option<Message>

Wait for next frame to come. (support incoming fragmented frames)

Source

pub async fn send_text<T: AsRef<str>>(&mut self, t: T) -> WebsocketResult<()>

Send a text frame

Trait Implementations§

Source§

impl<S: Debug> Debug for Websocket<S>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<S> Freeze for Websocket<S>

§

impl<S> !RefUnwindSafe for Websocket<S>

§

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

§

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

§

impl<S> Unpin for Websocket<S>

§

impl<S> !UnwindSafe for Websocket<S>

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