Struct WebSocket 

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

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

Implementations

impl<T> WebSocket<JsonHandler<T>>

where T: JsonWebSocketHandler,

pub fn new_json(handler: T) -> Self

Build a new trillium WebSocket handler from the provided JsonWebSocketHandler

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 allow_origins<'a>( self, origins: impl IntoIterator<Item = &'a str>, ) -> Self

Accept handshakes only from pages on these origins.

websocket.allow_origins(["https://app.example.com", "https://admin.example.com"]);

Origins are compared exactly, after normalizing default ports and idn hosts. Nothing is matched by prefix or suffix, because an allowed origin of example.com matched by suffix also admits evil-example.com. For a family of subdomains, use allow_origin_fn.

A request with no Origin header is allowed, as it did not come from a browser.

Panics

Panics if any of the provided strings is not a url with a scheme and a host, or if it carries a path, query, fragment, or userinfo.

pub fn allow_origin_fn<F>(self, predicate: F) -> Self

where F: Fn(Option<&str>) -> bool + Send + Sync + 'static,

Accept handshakes for which this predicate returns true.

The argument is the raw Origin header, so None (a non-browser client) stays distinguishable from Some("null") (a sandboxed iframe or a file:// page, which is attacker-reachable and should generally be rejected).

websocket.allow_origin_fn(|origin| match origin {
    None => true,
    Some(origin) => origin
        .strip_prefix("https://")
        .is_some_and(|host| host == "example.com" || host.ends_with(".example.com")),
});

pub fn allow_any_origin(self) -> Self

Accept handshakes from any origin, disabling the same-origin default.

Any page on the web can then open a socket to this handler and act with the browser’s ambient authority — the visitor’s cookies are attached to the handshake. Only do this if the socket is either unauthenticated or authenticated by something the page cannot replay, such as a token the client sends in its first message.

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

pub fn required(self) -> Self

configure this handler to halt and send back a 426 Upgrade Required if a websocket cannot be negotiated

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,

async fn run(&self, conn: Conn) -> Conn

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

async fn init(&mut self, info: &mut Info)

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 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 in a subsequent call to Handler::upgrade

async fn upgrade(&self, upgrade: Upgrade)

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 before_send(&self, conn: Conn) -> impl Future<Output = Conn> + Send

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.