Struct resource_proxy_pingora::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>>,
    pub declare_charset: Option<String>,
    pub declare_charset_types: Option<Vec<MimeMatch>>,
}

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).

declare_charset: Option<String>

The character set to declare for text files.

declare_charset_types: Option<Vec<MimeMatch>>

MIME type that the declare_charset setting should apply to. This command line flag can be specified multiple times.

Trait Implementations

impl Args for StaticFilesOpt

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can update self.

impl CommandFactory for StaticFilesOpt

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

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 FromArgMatches for StaticFilesOpt

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for StaticFilesOpt

fn parse() -> Self

Parse from std::env::args_os(), exit on error.

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

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Self

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, exit on error.

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, exit on error.

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error>

where I: IntoIterator<Item = T>, T: Into<OsString> + Clone,

Update from iterator, return Err on error.