Struct WebSocket

Source
pub struct WebSocket<B = RequestBody>
where B: BodyStream,
{ /* private fields */ }

Implementations§

Source§

impl<B> WebSocket<B>
where B: BodyStream,

Source

pub fn set_ping_interval(&mut self, dur: Duration) -> &mut Self

Set interval duration of server side ping message to client.

Source

pub fn set_max_unanswered_ping(&mut self, size: u8) -> &mut Self

Set max number of consecutive server side ping messages that are not answered by client.

§Panic:

when 0 is passed as argument.

Source

pub fn msg_sender(&self) -> &ResponseSender

Get a reference of Websocket message sender. Can be used to send message to client.

Source

pub fn on_msg<F>(&mut self, func: F) -> &mut Self
where F: for<'a> FnMut(&'a mut ResponseSender, Message) -> Pin<Box<dyn Future<Output = ()> + 'a>> + 'static,

Async function that would be called when new message arrived from client.

Source

pub fn on_err<F, Fut>(&mut self, func: F) -> &mut Self
where F: FnMut(WsError<B::Error>) -> Fut + 'static, Fut: Future<Output = ()> + 'static,

Async function that would be called when error occurred.

Source

pub fn on_close<F, Fut>(&mut self, func: F) -> &mut Self
where F: FnOnce(Pin<&mut RequestStream<B>>) -> Fut + 'static, Fut: Future<Output = ()> + 'static,

Async function that would be called when closing the websocket connection.

Trait Implementations§

Source§

impl<'a, 'r, C, B> FromRequest<'a, WebContext<'r, C, B>> for WebSocket<B>
where C: 'static, B: BodyStream + Default + 'static,

Source§

type Type<'b> = WebSocket<B>

Source§

type Error = Error

Source§

async fn from_request( ctx: &'a WebContext<'r, C, B>, ) -> Result<Self, Self::Error>

Source§

impl<'r, C, B> Responder<WebContext<'r, C, B>> for WebSocket<B>
where B: BodyStream + 'static,

Source§

type Response = Response<ResponseBody>

Source§

type Error = Infallible

Source§

async fn respond( self, _: WebContext<'r, C, B>, ) -> Result<Self::Response, Self::Error>

generate response from given request.
Source§

fn map(self, res: Self::Response) -> Result<Self::Response, Self::Error>
where Self: Sized,

map response type and mutate it’s state. default to pass through without any modification.

Auto Trait Implementations§

§

impl<B> Freeze for WebSocket<B>
where B: Freeze,

§

impl<B = RequestBody> !RefUnwindSafe for WebSocket<B>

§

impl<B = RequestBody> !Send for WebSocket<B>

§

impl<B = RequestBody> !Sync for WebSocket<B>

§

impl<B> Unpin for WebSocket<B>
where B: Unpin,

§

impl<B = RequestBody> !UnwindSafe for WebSocket<B>

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> BorrowState<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

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

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

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