Struct hyper_staticfile::Resolver

pub struct Resolver<O = TokioFileOpener> {
    pub opener: Arc<O>,
    pub allowed_encodings: AcceptEncoding,
}

Resolves request paths to files.

This struct resolves files based on the request path. The path is first sanitized, then mapped to a file on the filesystem. If the path corresponds to a directory, it will try to look for a directory index.

Cloning this struct is a cheap operation.

Fields

opener: Arc<O>

The (virtual) filesystem used to open files.

allowed_encodings: AcceptEncoding

Encodings the client is allowed to request with Accept-Encoding.

This only supports pre-encoded files, that exist adjacent to the original file, but with an additional .br or .gz suffix (after the original extension).

Typically initialized with AcceptEncoding::all() or AcceptEncoding::none().

Implementations

impl Resolver<TokioFileOpener>

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

Create a resolver that resolves files inside a root directory on the regular filesystem.

impl<O: FileOpener> Resolver<O>

pub fn with_opener(opener: O) -> Self

Create a resolver with a custom file opener.

pub async fn resolve_request<B>(
    &self,
    req: &Request<B>
) -> Result<ResolveResult<O::File>, IoError>

Resolve the request by trying to find the file in the root.

The returned future may error for unexpected IO errors, passing on the std::io::Error. Certain expected IO errors are handled, though, and simply reflected in the result. These are NotFound and PermissionDenied.

pub async fn resolve_path(
    &self,
    request_path: &str,
    accept_encoding: AcceptEncoding
) -> Result<ResolveResult<O::File>, IoError>

Resolve the request path by trying to find the file in the given root.

The returned future may error for unexpected IO errors, passing on the std::io::Error. Certain expected IO errors are handled, though, and simply reflected in the result. These are NotFound and PermissionDenied.

Note that, unlike resolve_request, it is up to the caller to check the request method and optionally the ‘Accept-Encoding’ header.

Trait Implementations

impl<O> Clone for Resolver<O>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.