Struct ServeDir

pub struct ServeDir<F = DefaultServeDirFallback> { /* private fields */ }

Available on crate feature fs only.

Service that serves files from a given directory and all its sub directories.

The Content-Type will be guessed from the file extension.

An empty response with status 404 Not Found will be returned if:

• The file doesn’t exist
• Any segment of the path contains ..
• Any segment of the path contains a backslash
• On unix, any segment of the path referenced as directory is actually an existing file (/file.html/something)
• We don’t have necessary permissions to read the file

Example

use std::net::SocketAddr;

use hyper_util::rt::{TokioExecutor, TokioIo};
use hyper_util::server::conn::auto::Builder;
use tokio::net::TcpListener;

use tower_async_hyper::{TowerHyperServiceExt, HyperBody};
use tower_async_http::{services::ServeDir, ServiceBuilderExt};
use tower_async::ServiceBuilder;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    let addr: SocketAddr = ([127, 0, 0, 1], 8080).into();
    let listener = TcpListener::bind(addr).await?;

    // This will serve files in the "assets" directory and
    // its subdirectories
    let service = ServiceBuilder::new()
        .map_request_body(HyperBody::from)
        .service(ServeDir::new("assets"))
        .into_hyper_service();

    loop {
        let (stream, _) = listener.accept().await?;
        let service = service.clone();
        tokio::spawn(async move {
            let stream = TokioIo::new(stream);
            let result = Builder::new(TokioExecutor::new())
                .serve_connection(stream, service)
                .await;
            if let Err(e) = result {
                eprintln!("server connection error: {}", e);
            }
        });
    }
}

Implementations

impl ServeDir<DefaultServeDirFallback>

pub fn new<P>(path: P) -> Self

where P: AsRef<Path>,

Create a new ServeDir.

impl<F> ServeDir<F>

pub fn append_index_html_on_directories(self, append: bool) -> Self

If the requested path is a directory append index.html.

This is useful for static sites.

Defaults to true.

pub fn with_buf_chunk_size(self, chunk_size: usize) -> Self

Set a specific read buffer chunk size.

The default capacity is 64kb.

pub fn precompressed_gzip(self) -> Self

Informs the service that it should also look for a precompressed gzip version of any file in the directory.

Assuming the dir directory is being served and dir/foo.txt is requested, a client with an Accept-Encoding header that allows the gzip encoding will receive the file dir/foo.txt.gz instead of dir/foo.txt. If the precompressed file is not available, or the client doesn’t support it, the uncompressed version will be served instead. Both the precompressed version and the uncompressed version are expected to be present in the directory. Different precompressed variants can be combined.

pub fn precompressed_br(self) -> Self

Informs the service that it should also look for a precompressed brotli version of any file in the directory.

Assuming the dir directory is being served and dir/foo.txt is requested, a client with an Accept-Encoding header that allows the brotli encoding will receive the file dir/foo.txt.br instead of dir/foo.txt. If the precompressed file is not available, or the client doesn’t support it, the uncompressed version will be served instead. Both the precompressed version and the uncompressed version are expected to be present in the directory. Different precompressed variants can be combined.

pub fn precompressed_deflate(self) -> Self

Informs the service that it should also look for a precompressed deflate version of any file in the directory.

Assuming the dir directory is being served and dir/foo.txt is requested, a client with an Accept-Encoding header that allows the deflate encoding will receive the file dir/foo.txt.zz instead of dir/foo.txt. If the precompressed file is not available, or the client doesn’t support it, the uncompressed version will be served instead. Both the precompressed version and the uncompressed version are expected to be present in the directory. Different precompressed variants can be combined.

pub fn precompressed_zstd(self) -> Self

Informs the service that it should also look for a precompressed zstd version of any file in the directory.

Assuming the dir directory is being served and dir/foo.txt is requested, a client with an Accept-Encoding header that allows the zstd encoding will receive the file dir/foo.txt.zst instead of dir/foo.txt. If the precompressed file is not available, or the client doesn’t support it, the uncompressed version will be served instead. Both the precompressed version and the uncompressed version are expected to be present in the directory. Different precompressed variants can be combined.

pub fn fallback<F2>(self, new_fallback: F2) -> ServeDir<F2>

Set the fallback service.

This service will be called if there is no file at the path of the request.

The status code returned by the fallback will not be altered. Use ServeDir::not_found_service to set a fallback and always respond with 404 Not Found.

Example

This can be used to respond with a different file:

use std::net::SocketAddr;

use hyper_util::rt::{TokioExecutor, TokioIo};
use hyper_util::server::conn::auto::Builder;
use tokio::net::TcpListener;

use tower_async_hyper::{TowerHyperServiceExt, HyperBody};
use tower_async_http::{services::{ServeDir, ServeFile}, ServiceBuilderExt};
use tower_async::ServiceBuilder;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    let addr: SocketAddr = ([127, 0, 0, 1], 8080).into();
    let listener = TcpListener::bind(addr).await?;

    // This will serve files in the "assets" directory and
    // its subdirectories
    let service = ServiceBuilder::new()
        .map_request_body(HyperBody::from)
        .service(ServeDir::new("assets")
            .fallback(ServeFile::new("assets/not_found.html")))
        .into_hyper_service();

    loop {
        let (stream, _) = listener.accept().await?;
        let service = service.clone();
        tokio::spawn(async move {
            let stream = TokioIo::new(stream);
            let result = Builder::new(TokioExecutor::new())
                .serve_connection(stream, service)
                .await;
            if let Err(e) = result {
                eprintln!("server connection error: {}", e);
            }
        });
    }
}

pub fn not_found_service<F2>(self, new_fallback: F2) -> ServeDir<SetStatus<F2>>

Set the fallback service and override the fallback’s status code to 404 Not Found.

This service will be called if there is no file at the path of the request.

Example

This can be used to respond with a different file:

use std::net::SocketAddr;

use hyper_util::rt::{TokioExecutor, TokioIo};
use hyper_util::server::conn::auto::Builder;
use tokio::net::TcpListener;

use tower_async_hyper::{TowerHyperServiceExt, HyperBody};
use tower_async_http::{services::{ServeDir, ServeFile}, ServiceBuilderExt};
use tower_async::ServiceBuilder;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    let addr: SocketAddr = ([127, 0, 0, 1], 8080).into();
    let listener = TcpListener::bind(addr).await?;

    // This will serve files in the "assets" directory and
    // its subdirectories
    let service = ServiceBuilder::new()
        .map_request_body(HyperBody::from)
        .service(ServeDir::new("assets")
            // respond with `404 Not Found` and the contents of `not_found.html` for missing files
            .not_found_service(ServeFile::new("assets/not_found.html")))
        .into_hyper_service();

    loop {
        let (stream, _) = listener.accept().await?;
        let service = service.clone();
        tokio::spawn(async move {
            let stream = TokioIo::new(stream);
            let result = Builder::new(TokioExecutor::new())
                .serve_connection(stream, service)
                .await;
            if let Err(e) = result {
                eprintln!("server connection error: {}", e);
            }
        });
    }
}

Setups like this are often found in single page applications.

pub fn call_fallback_on_method_not_allowed(self, call_fallback: bool) -> Self

Customize whether or not to call the fallback for requests that aren’t GET or HEAD.

Defaults to not calling the fallback and instead returning 405 Method Not Allowed.

pub async fn try_call<ReqBody, FResBody>( &self, req: Request<ReqBody>, ) -> Result<Response<ResponseBody>, Error>

where F: Service<Request<ReqBody>, Response = Response<FResBody>, Error = Infallible> + Clone, FResBody: Body<Data = Bytes> + Send + 'static, FResBody::Error: Into<Box<dyn Error + Send + Sync>>,

Call the service and get a future that contains any std::io::Error that might have happened.

By default <ServeDir as Service<_>>::call will handle IO errors and convert them into responses. It does that by converting std::io::ErrorKind::NotFound and std::io::ErrorKind::PermissionDenied to 404 Not Found and any other error to 500 Internal Server Error. The error will also be logged with tracing.

If you want to manually control how the error response is generated you can make a new service that wraps a ServeDir and calls try_call instead of call.

Example

use std::net::SocketAddr;
use std::{io, convert::Infallible};

use hyper_util::rt::{TokioExecutor, TokioIo};
use hyper_util::server::conn::auto::Builder;
use tokio::net::TcpListener;
use http::{Request, Response, StatusCode};
use http_body::Body;
use http_body_util::{BodyExt, Full, combinators::UnsyncBoxBody};
use bytes::Bytes;

use tower_async_hyper::{TowerHyperServiceExt, HyperBody};
use tower_async_http::{services::{ServeDir, ServeFile}, ServiceBuilderExt};
use tower_async::{ServiceBuilder, BoxError};

async fn serve_dir(
    request: Request<HyperBody>
) -> Result<Response<UnsyncBoxBody<Bytes, BoxError>>, Infallible> {
    let mut service = ServeDir::new("assets");

    match service.try_call(request).await {
        Ok(response) => {
            Ok(response.map(|body| body.map_err(Into::into).boxed_unsync()))
        }
        Err(err) => {
            let body = Full::from("Something went wrong...")
                .map_err(Into::into)
                .boxed_unsync();
            let response = Response::builder()
                .status(StatusCode::INTERNAL_SERVER_ERROR)
                .body(body)
                .unwrap();
            Ok(response)
        }
    }
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error + Send + Sync>> {
    let addr: SocketAddr = ([127, 0, 0, 1], 8080).into();
    let listener = TcpListener::bind(addr).await?;

    // This will serve files in the "assets" directory and
    // its subdirectories
    let service = ServiceBuilder::new()
        .map_request_body(HyperBody::from)
        .service_fn(serve_dir)
        .into_hyper_service();

    loop {
        let (stream, _) = listener.accept().await?;
        let service = service.clone();
        tokio::spawn(async move {
            let stream = TokioIo::new(stream);
            let result = Builder::new(TokioExecutor::new())
                .serve_connection(stream, service)
                .await;
            if let Err(e) = result {
                eprintln!("server connection error: {}", e);
            }
        });
    }
}

Trait Implementations

impl<F: Clone> Clone for ServeDir<F>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for ServeDir<F>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<ReqBody, F, FResBody> Service<Request<ReqBody>> for ServeDir<F>

where F: Service<Request<ReqBody>, Response = Response<FResBody>, Error = Infallible> + Clone, FResBody: Body<Data = Bytes> + Send + 'static, FResBody::Error: Into<Box<dyn Error + Send + Sync>>,

type Response = Response<ResponseBody>

Responses given by the service.

type Error = Infallible

Errors produced by the service.

async fn call( &self, req: Request<ReqBody>, ) -> Result<Self::Response, Self::Error>

Process the request and return the response asynchronously.