pub struct StaticCompiledHandler { /* private fields */ }Expand description
The static compiled handler which contains the compile-time loaded assets
Implementations§
Source§impl StaticCompiledHandler
impl StaticCompiledHandler
Sourcepub fn new(root: DirEntry) -> Self
pub fn new(root: DirEntry) -> Self
Constructs a new StaticCompiledHandler. This must be used in
conjunction with root!. See crate-level docs for
example usage.
Sourcepub fn with_index_file(self, file: &'static str) -> Self
pub fn with_index_file(self, file: &'static str) -> Self
Configures the optional index file for this StaticCompiledHandler. See the crate-level docs for example usage.
Trait Implementations§
Source§impl Clone for StaticCompiledHandler
impl Clone for StaticCompiledHandler
Source§fn clone(&self) -> StaticCompiledHandler
fn clone(&self) -> StaticCompiledHandler
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for StaticCompiledHandler
impl Debug for StaticCompiledHandler
Source§impl Handler for StaticCompiledHandler
impl Handler for StaticCompiledHandler
Source§async fn run(&self, conn: Conn) -> Conn
async fn run(&self, conn: Conn) -> Conn
Executes this handler, performing any modifications to the Conn that are desired.
Source§fn init(&mut self, info: &mut Info) -> impl Future<Output = ()> + Send
fn init(&mut self, info: &mut Info) -> impl Future<Output = ()> + Send
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(&self, conn: Conn) -> impl Future<Output = Conn> + Send
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. Read more
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::upgradeSource§fn upgrade(&self, upgrade: Upgrade) -> impl Future<Output = ()> + Send
fn upgrade(&self, upgrade: Upgrade) -> impl Future<Output = ()> + Send
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.impl Copy for StaticCompiledHandler
Auto Trait Implementations§
impl Freeze for StaticCompiledHandler
impl RefUnwindSafe for StaticCompiledHandler
impl Send for StaticCompiledHandler
impl Sync for StaticCompiledHandler
impl Unpin for StaticCompiledHandler
impl UnsafeUnpin for StaticCompiledHandler
impl UnwindSafe for StaticCompiledHandler
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