Struct WebTransport 

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

A Trillium Handler that accepts WebTransport sessions.

Add this to your handler chain and provide a WebTransportHandler (or a closure) to process each session.

Example

use trillium_webtransport::{WebTransport, WebTransportConnection};

let handler = WebTransport::new(|conn: WebTransportConnection| async move {
    while let Some(stream) = conn.accept_next_stream().await {
        // handle stream...
    }
});

Implementations

impl<H> WebTransport<H>

where H: WebTransportHandler,

pub fn new(handler: H) -> Self

Create a new WebTransport handler that passes each session to handler.

pub fn with_max_datagram_buffer(self, max: usize) -> Self

Set the maximum number of datagrams to buffer per session.

When the buffer is full, the oldest datagram is dropped to make room for the newest.

• max > 1 — FIFO ring-buffer that tolerates bursts up to max datagrams before dropping. Good for ordered event streams where some loss is acceptable.
• max = 1 — “latest-only” semantics: if multiple datagrams arrive while your recv_datagram loop is busy, only the most recent is retained. Good for streaming state (positions, sensor readings) where older values are invalidated by newer ones.

Default: 16.

Trait Implementations

impl<H> Handler for WebTransport<H>

where H: WebTransportHandler,

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.