Struct trillium_static::StaticFileHandler
source · pub struct StaticFileHandler { /* private fields */ }
Expand description
trillium handler to serve static files from the filesystem
Implementations§
source§impl StaticFileHandler
impl StaticFileHandler
sourcepub fn new(fs_root: impl AsRef<Path>) -> Self
pub fn new(fs_root: impl AsRef<Path>) -> Self
builds a new StaticFileHandler
If the fs_root is a file instead of a directory, that file will be served at all paths.
use trillium_static::{StaticFileHandler, crate_relative_path};
use trillium_testing::prelude::*;
let mut handler = StaticFileHandler::new(crate_relative_path!("examples/files"));
assert_not_handled!(get("/").run_async(&handler).await); // no index file configured
assert_ok!(
get("/index.html").run_async(&handler).await,
"<h1>hello world</h1>",
"content-type" => "text/html; charset=utf-8"
);
sourcepub fn without_etag_header(self) -> Self
pub fn without_etag_header(self) -> Self
do not set an etag header
sourcepub fn without_modified_header(self) -> Self
pub fn without_modified_header(self) -> Self
do not set last-modified header
sourcepub fn with_index_file(self, file: &str) -> Self
pub fn with_index_file(self, file: &str) -> Self
sets the index file on this StaticFileHandler
use trillium_static::{StaticFileHandler, crate_relative_path};
let mut handler = StaticFileHandler::new(crate_relative_path!("examples/files"))
.with_index_file("index.html");
use trillium_testing::prelude::*;
assert_ok!(
get("/").run_async(&handler).await,
"<h1>hello world</h1>", "content-type" => "text/html; charset=utf-8"
);
Trait Implementations§
source§impl Debug for StaticFileHandler
impl Debug for StaticFileHandler
source§impl Handler for StaticFileHandler
impl Handler for StaticFileHandler
source§fn init<'life0, 'life1, 'async_trait>(
&'life0 mut self,
_info: &'life1 mut Info,
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn init<'life0, 'life1, 'async_trait>(
&'life0 mut self,
_info: &'life1 mut Info,
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: '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 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 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
source§fn has_upgrade(&self, _upgrade: &Upgrade<BoxedTransport>) -> bool
fn has_upgrade(&self, _upgrade: &Upgrade<BoxedTransport>) -> 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<BoxedTransport>,
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>where
'life0: 'async_trait,
Self: 'async_trait,
fn upgrade<'life0, 'async_trait>(
&'life0 self,
_upgrade: Upgrade<BoxedTransport>,
) -> 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.Auto Trait Implementations§
impl Freeze for StaticFileHandler
impl RefUnwindSafe for StaticFileHandler
impl Send for StaticFileHandler
impl Sync for StaticFileHandler
impl Unpin for StaticFileHandler
impl UnwindSafe for StaticFileHandler
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