Struct poem::endpoint::StaticFileEndpoint

pub struct StaticFileEndpoint { /* private fields */ }

This is supported on crate feature static-files only.

Single static file handling service.

Errors

• StaticFileError

Implementations

impl StaticFileEndpoint

pub fn new(path: impl Into<PathBuf>) -> Self

Create new single static file service for a specified file path.

Example

use poem::{endpoint::StaticFileEndpoint, Route};

let app = Route::new().at("/logo.png", StaticFileEndpoint::new("/etc/logo.png"));

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 StaticFileEndpoint

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.