Struct poem::endpoint::StaticFilesEndpoint

pub struct StaticFilesEndpoint { /* private fields */ }

This is supported on crate feature static-files only.

Static files handling service.

Errors

• StaticFileError

Implementations

impl StaticFilesEndpoint

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"),
);

pub fn show_files_listing(self) -> Self

Show files listing for directories.

By default show files listing is disabled.

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.

pub fn prefer_utf8(self, value: bool) -> Self

Specifies whether text responses should signal a UTF-8 encoding.

Default is true.

Trait Implementations

impl Endpoint for StaticFilesEndpoint

type Output = Response

Represents the response of the endpoint.

fn call<'life0, 'async_trait>(
    &'life0 self,
    req: Request
) -> Pin<Box<dyn Future<Output = Result<Self::Output>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Get the response to the request.

fn get_response<'life0, 'async_trait>(
    &'life0 self,
    req: Request
) -> Pin<Box<dyn Future<Output = Response> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Get the response to the request and return a Response.