Struct WebSocketConn 

pub struct WebSocketConn { /* private fields */ }

Available on crate feature websockets only.

A struct that represents an specific websocket connection.

This can be thought of as a combination of a async_tungstenite::WebSocketStream and a trillium::Conn, as it contains a combination of their fields and associated functions.

The WebSocketConn implements Stream<Item=Result<Message, Error>>, and can be polled with StreamExt::next

Implementations

impl WebSocketConn

pub async fn send_string(&mut self, string: String) -> Result<(), Error>

send a Message::Text variant

pub async fn send_bytes(&mut self, bin: Vec<u8>) -> Result<(), Error>

send a Message::Binary variant

pub async fn send(&mut self, message: Message) -> Result<(), Error>

Sends a Message to the client and flushes it to the socket

When sending many messages in quick succession, feed coalesces them into fewer socket writes.

pub async fn feed(&mut self, message: Message) -> Result<(), Error>

Enqueues a Message without immediately writing it to the socket

The message is encoded into an internal write buffer. The buffer is written out when it fills, when this conn is next polled for an inbound message and none is immediately available, or on flush or send. If you feed a message and then await anything other than this conn, call flush first.

pub async fn flush(&mut self) -> Result<(), Error>

Writes any buffered outbound messages to the socket

pub fn swansong(&self) -> Swansong

retrieve a clone of the server’s Swansong

pub async fn close(&mut self) -> Result<(), Error>

close the websocket connection gracefully

pub fn headers(&self) -> &Headers

retrieve the request headers for this conn

pub fn peer_ip(&self) -> Option<IpAddr>

retrieves the peer ip for this conn, if available

pub fn set_peer_ip(&mut self, peer_ip: Option<IpAddr>) -> &mut WebSocketConn

Sets the peer ip for this conn

pub fn path(&self) -> &str

retrieves the path part of the request url, up to and excluding any query component

pub fn querystring(&self) -> &str

Retrieves the query component of the path, excluding ?. Returns an empty string if there is no query component.

pub fn method(&self) -> Method

retrieve the request method for this conn

pub fn state<T>(&self) -> Option<&T>

where T: Send + Sync + 'static,

retrieve state from the state set that has been accumulated by trillium handlers run on the trillium::Conn before it became a websocket. see trillium::Conn::state for more information

pub fn state_mut<T>(&mut self) -> Option<&mut T>

where T: Send + Sync + 'static,

retrieve a mutable borrow of the state from the state set

pub fn insert_state<T>(&mut self, state: T) -> Option<T>

where T: Send + Sync + 'static,

inserts new state

returns the previously set state of the same type, if any existed

pub fn state_entry<T>(&mut self) -> Entry<'_, T>

where T: Send + Sync + 'static,

Returns an Entry for the state typeset that can be used with functions like Entry::or_insert, Entry::or_insert_with, Entry::and_modify, and others.

pub fn take_state<T>(&mut self) -> Option<T>

where T: Send + Sync + 'static,

take some type T out of the state set that has been accumulated by trillium handlers run on the trillium::Conn before it became a websocket. see trillium::Conn::take_state for more information

pub fn take_inbound_stream( &mut self, ) -> Option<impl Stream<Item = Result<Message, Error>> + use<>>

take the inbound Message stream from this conn

pub fn inbound_stream( &mut self, ) -> Option<impl Stream<Item = Result<Message, Error>>>

borrow the inbound Message stream from this conn

Trait Implementations

impl AsMut<TypeSet> for WebSocketConn

fn as_mut(&mut self) -> &mut TypeSet

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<TypeSet> for WebSocketConn

fn as_ref(&self) -> &TypeSet

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

impl Debug for WebSocketConn

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

Formats the value using the given formatter.

impl Stream for WebSocketConn

type Item = Result<Message, Error>

Values yielded by the stream.

fn poll_next( self: Pin<&mut WebSocketConn>, cx: &mut Context<'_>, ) -> Poll<Option<<WebSocketConn as Stream>::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.