Struct gotham::handler::FileOptions

pub struct FileOptions { /* private fields */ }

Options to pass to file or dir handlers. Allows overriding default behaviour for compression, cache control headers, etc.

FileOptions implements From for String and PathBuf (and related reference types) - so that a path can be passed to router builder methods if only default options are required.

For overridding default options, FileOptions provides builder methods. The default values and use of the builder methods are shown in the example below.

let default_options = FileOptions::from("my_static_path");
let from_builder = FileOptions::new("my_static_path")
    .with_cache_control("public")
    .with_gzip(false)
    .with_brotli(false)
    .build();

assert_eq!(default_options, from_builder);

Implementations

impl FileOptions

pub fn new<P: AsRef<Path>>(path: P) -> Self where
    PathBuf: From<P>, 

Create a new FileOptions with default values.

pub fn with_cache_control(&mut self, cache_control: &str) -> &mut Self

Sets the “cache_control” header in static file responses to the given value.

pub fn with_gzip(&mut self, gzip: bool) -> &mut Self

If true, given a request for FILE, serves FILE.gz if it exists in the static directory and if the accept-encoding header is set to allow gzipped content (defaults to false).

pub fn with_brotli(&mut self, brotli: bool) -> &mut Self

If true, given a request for FILE, serves FILE.br if it exists in the static directory and if the accept-encoding header is set to allow brotli content (defaults to false).

pub fn build(&mut self) -> Self

Clones self to return an owned value for passing to a handler.

Trait Implementations

impl Clone for FileOptions

fn clone(&self) -> FileOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FileOptions

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

Formats the value using the given formatter.

impl<'a> From<&'a Path> for FileOptions

fn from(t: &'a Path) -> FileOptions

Performs the conversion.

impl<'a> From<&'a String> for FileOptions

fn from(t: &'a String) -> FileOptions

Performs the conversion.

impl<'a> From<&'a str> for FileOptions

fn from(t: &'a str) -> FileOptions

Performs the conversion.

impl<'a> From<PathBuf> for FileOptions

fn from(t: PathBuf) -> FileOptions

Performs the conversion.

impl<'a> From<String> for FileOptions

fn from(t: String) -> FileOptions

Performs the conversion.

impl PartialEq<FileOptions> for FileOptions

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for FileOptions