Struct poem::endpoint::StaticFilesEndpoint
source · [−]pub struct StaticFilesEndpoint { /* private fields */ }
Available on crate feature
static-files
only.Expand description
Implementations
sourceimpl StaticFilesEndpoint
impl StaticFilesEndpoint
sourcepub fn new(path: impl Into<PathBuf>) -> Self
pub fn new(path: impl Into<PathBuf>) -> Self
Create new static files service for a specified base directory.
Example
use poem::{endpoint::StaticFilesEndpoint, Route};
let app = Route::new().nest(
"/files",
StaticFilesEndpoint::new("/etc/www")
.show_files_listing()
.index_file("index.html"),
);
sourcepub fn show_files_listing(self) -> Self
pub fn show_files_listing(self) -> Self
Show files listing for directories.
By default show files listing is disabled.
sourcepub fn index_file(self, index: impl Into<String>) -> Self
pub fn index_file(self, index: impl Into<String>) -> Self
Set index file
Shows specific index file for directories instead of showing files listing.
If the index file is not found, files listing is shown as a fallback if Files::show_files_listing() is set.
sourcepub fn prefer_utf8(self, value: bool) -> Self
pub fn prefer_utf8(self, value: bool) -> Self
Specifies whether text responses should signal a UTF-8 encoding.
Default is true
.
sourcepub fn redirect_to_slash_directory(self) -> Self
pub fn redirect_to_slash_directory(self) -> Self
Redirects to a slash-ended path when browsing a directory.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for StaticFilesEndpoint
impl Send for StaticFilesEndpoint
impl Sync for StaticFilesEndpoint
impl Unpin for StaticFilesEndpoint
impl UnwindSafe for StaticFilesEndpoint
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more