Struct trillium_websockets::WebSocket

pub struct WebSocket<H> { /* private fields */ }

The trillium handler. See crate-level docs for example usage.

Implementations

impl<H> WebSocket<H>where
    H: WebSocketHandler,

pub fn new(handler: H) -> Self

Build a new WebSocket with an async handler function that receives a WebSocketConn

pub fn with_protocols(self, protocols: &[&str]) -> Self

protocols is a sequence of known protocols. On successful handshake, the returned response headers contain the first protocol in this list which the server also knows.

pub fn with_protocol_config(self, config: WebSocketConfig) -> Self

configure the websocket protocol

Trait Implementations

impl<H: Debug> Debug for WebSocket<H>

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

Formats the value using the given formatter.

impl<H> Deref for WebSocket<H>

type Target = H

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<H> DerefMut for WebSocket<H>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<H> Handler for WebSocket<H>where
    H: WebSocketHandler,

fn run<'life0, 'async_trait>(
    &'life0 self,
    conn: Conn
) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Executes this handler, performing any modifications to the Conn that are desired.

fn has_upgrade(&self, upgrade: &Upgrade) -> bool

predicate function answering the question of whether this Handler would like to take ownership of the negotiated Upgrade. If this returns true, you must implement [Handler::upgrade]. The first handler that responds true to this will receive ownership of the [trillium::Upgrade][crate::Upgrade] in a subsequent call to [Handler::upgrade]

fn upgrade<'life0, 'async_trait>(
    &'life0 self,
    upgrade: Upgrade
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
    'life0: 'async_trait,
    Self: 'async_trait,

This will only be called if the handler reponds true to [Handler::has_upgrade] and will only be called once for this upgrade. There is no return value, and this function takes exclusive ownership of the underlying transport once this is called. You can downcast the transport to whatever the source transport type is and perform any non-http protocol communication that has been negotiated. You probably don’t want this unless you’re implementing something like websockets. Please note that for many transports such as TcpStreams, dropping the transport (and therefore the Upgrade) will hang up / disconnect.

fn init<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    _info: &'life1 mut Info
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>>where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,

Performs one-time async set up on a mutable borrow of the Handler before the server starts accepting requests. This allows a Handler to be defined in synchronous code but perform async setup such as establishing a database connection or fetching some state from an external source. This is optional, and chances are high that you do not need this.

fn before_send<'life0, 'async_trait>(
    &'life0 self,
    conn: Conn
) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait, Global>>where
    'life0: 'async_trait,
    Self: 'async_trait,

Performs any final modifications to this conn after all handlers have been run. Although this is a slight deviation from the simple conn->conn->conn chain represented by most Handlers, it provides an easy way for libraries to effectively inject a second handler into a response chain. This is useful for loggers that need to record information both before and after other handlers have run, as well as database transaction handlers and similar library code.

fn name(&self) -> Cow<'static, str>

Customize the name of your handler. This is used in Debug implementations. The default is the type name of this handler.