Struct StaticFilesConf

pub struct StaticFilesConf {
    pub root: Option<PathBuf>,
    pub canonicalize_uri: bool,
    pub redirect_prefix: Option<String>,
    pub index_file: Vec<String>,
    pub page_404: Option<String>,
    pub precompressed: Vec<CompressionAlgorithm>,
}

Configuration file settings of the static files module

Fields

root: Option<PathBuf>

The root directory.

canonicalize_uri: bool

Redirect /file%2e.txt to /file.txt and /dir to /dir/.

redirect_prefix: Option<String>

When canonicalize_uri is used, prefix redirect targets with the given string. This is useful when the static files handler is applied to a subdirectory of the actual webspace.

index_file: Vec<String>

List of index files to look for in a directory.

page_404: Option<String>

URI path of the page to display instead of the default Not Found page, e.g. /404.html

precompressed: Vec<CompressionAlgorithm>

List of file extensions to check when looking for pre-compressed versions of a file. Supported file extensions are gz (gzip), zz (zlib deflate), z (compress), br (Brotli), zst (Zstandard).

Implementations

impl StaticFilesConf

pub fn merge_with_opt(&mut self, opt: StaticFilesOpt)

Merges the command line options into the current configuration. Any command line options present overwrite existing settings.

Trait Implementations

impl Debug for StaticFilesConf

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

Formats the value using the given formatter.

impl Default for StaticFilesConf

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for StaticFilesConf

where StaticFilesConf: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StaticFilesConf

fn eq(&self, other: &StaticFilesConf) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<StaticFilesConf> for StaticFilesHandler

type Error = Box<Error>

The type returned in the event of a conversion error.

fn try_from(conf: StaticFilesConf) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for StaticFilesConf

impl StructuralPartialEq for StaticFilesConf