Struct trillium_websockets::WebSocket
source · pub struct WebSocket<H> { /* private fields */ }
Expand description
The trillium handler. See crate-level docs for example usage.
Implementations§
source§impl<H> WebSocket<H>where
H: WebSocketHandler,
impl<H> WebSocket<H>where
H: WebSocketHandler,
sourcepub fn new(handler: H) -> Self
pub fn new(handler: H) -> Self
Build a new WebSocket with an async handler function that
receives a WebSocketConn
sourcepub fn with_protocols(self, protocols: &[&str]) -> Self
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.
sourcepub fn with_protocol_config(self, config: WebSocketConfig) -> Self
pub fn with_protocol_config(self, config: WebSocketConfig) -> Self
configure the websocket protocol
sourcepub fn required(self) -> Self
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§
source§impl<H> Handler for WebSocket<H>where
H: WebSocketHandler,
impl<H> Handler for WebSocket<H>where
H: WebSocketHandler,
source§fn run<'life0, 'async_trait>(
&'life0 self,
conn: Conn,
) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn run<'life0, 'async_trait>(
&'life0 self,
conn: Conn,
) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Executes this handler, performing any modifications to the
Conn that are desired.
source§fn has_upgrade(&self, upgrade: &Upgrade) -> bool
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
source§fn upgrade<'life0, 'async_trait>(
&'life0 self,
upgrade: Upgrade,
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn upgrade<'life0, 'async_trait>(
&'life0 self,
upgrade: Upgrade,
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: '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.source§fn init<'life0, 'life1, 'async_trait>(
&'life0 mut self,
_info: &'life1 mut Info,
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
'life0: 'async_trait,
'life1: 'async_trait,
Self: 'async_trait,
fn init<'life0, 'life1, 'async_trait>(
&'life0 mut self,
_info: &'life1 mut Info,
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>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. Read more
source§fn before_send<'life0, 'async_trait>(
&'life0 self,
conn: Conn,
) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>where
'life0: 'async_trait,
Self: 'async_trait,
fn before_send<'life0, 'async_trait>(
&'life0 self,
conn: Conn,
) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>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. Read more
Auto Trait Implementations§
impl<H> Freeze for WebSocket<H>where
H: Freeze,
impl<H> RefUnwindSafe for WebSocket<H>where
H: RefUnwindSafe,
impl<H> Send for WebSocket<H>where
H: Send,
impl<H> Sync for WebSocket<H>where
H: Sync,
impl<H> Unpin for WebSocket<H>where
H: Unpin,
impl<H> UnwindSafe for WebSocket<H>where
H: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more