Struct StaticFilesOpt

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

Command line options of the static files module

Fields

root: Option<PathBuf>

The root directory.

canonicalize_uri: Option<bool>

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

index_file: Option<Vec<String>>

Index file to look for when displaying a directory. This command line flag can be specified multiple times.

page_404: Option<String>

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

precompressed: Option<Vec<CompressionAlgorithm>>

File extension to check when looking for pre-compressed versions of a file. This command line flag can be specified multiple times. Supported file extensions are gz (gzip), zz (zlib deflate), z (compress), br (Brotli), zst (Zstandard).

Trait Implementations

impl Debug for StaticFilesOpt

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

Formats the value using the given formatter.

impl Default for StaticFilesOpt

fn default() -> StaticFilesOpt

Returns the “default value” for a type.

impl StructOpt for StaticFilesOpt

fn clap<'a, 'b>() -> App<'a, 'b>

Returns clap::App corresponding to the struct.

fn from_clap(matches: &ArgMatches<'_>) -> Self

Builds the struct from clap::ArgMatches. It’s guaranteed to succeed if matches originates from an App generated by StructOpt::clap called on the same type, otherwise it must panic.

fn from_args() -> Self

where Self: Sized,

Builds the struct from the command line arguments (std::env::args_os). Calls clap::Error::exit on failure, printing the error message and aborting the program.

fn from_args_safe() -> Result<Self, Error>

where Self: Sized,

Builds the struct from the command line arguments (std::env::args_os). Unlike StructOpt::from_args, returns clap::Error on failure instead of aborting the program, so calling .exit is up to you.

fn from_iter<I>(iter: I) -> Self

where Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making. Print the error message and quit the program in case of failure.

fn from_iter_safe<I>(iter: I) -> Result<Self, Error>

where Self: Sized, I: IntoIterator, <I as IntoIterator>::Item: Into<OsString> + Clone,

Gets the struct from any iterator such as a Vec of your making.