Struct ServeDir

pub struct ServeDir<FS: AsyncFs = TokioFs> { /* private fields */ }

Implementations

impl ServeDir<TokioFs>

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

Construct a new ServeDir with given path.

impl<FS: AsyncFs> ServeDir<FS>

pub fn with_fs(path: impl Into<PathBuf>, async_fs: FS) -> Self

construct a new ServeDir with given path and async file system type. The type must impl AsyncFs trait for properly handling file streaming.

pub fn chunk_size(&mut self, size: usize) -> &mut Self

hint for chunk size of async file streaming. it’s a best effort upper bound and should not be trusted to produce exact chunk size as under/over shoot can happen

pub async fn serve<Ext>( &self, req: &Request<Ext>, ) -> Result<Response<ChunkReader<FS::File>>, ServeError>

try to find a matching file from given input request and generate http response with stream reader of matched file.

Examples

async fn serve(req: &Request<()>) {
    let dir = ServeDir::new("sample");
    let res = dir.serve(&req).await;
}

Trait Implementations

impl<FS: Clone + AsyncFs> Clone for ServeDir<FS>

fn clone(&self) -> ServeDir<FS>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.