Struct StaticFilesHandler 

#[non_exhaustive]
pub struct StaticFilesHandler {
    pub path: String,
    pub upload_path_regex: String,
    pub http_headers: HashMap<String, String>,
    pub mime_type: String,
    pub expiration: Option<Duration>,
    pub require_matching_file: bool,
    pub application_readable: bool,
    /* private fields */
}

Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

path: String

Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.

upload_path_regex: String

Regular expression that matches the file paths for all files that should be referenced by this handler.

http_headers: HashMap<String, String>

HTTP headers to use for all responses from these URLs.

mime_type: String

MIME type used to serve all files served by this handler.

Defaults to file-specific MIME types, which are derived from each file’s filename extension.

expiration: Option<Duration>

Time a static file served by this handler should be cached by web proxies and browsers.

require_matching_file: bool

Whether this handler should match the request if the file referenced by the handler does not exist.

application_readable: bool

Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.

Implementations

impl StaticFilesHandler

pub fn new() -> Self

pub fn set_path<T: Into<String>>(self, v: T) -> Self

Sets the value of path.

pub fn set_upload_path_regex<T: Into<String>>(self, v: T) -> Self

Sets the value of upload_path_regex.

pub fn set_http_headers<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of http_headers.

pub fn set_mime_type<T: Into<String>>(self, v: T) -> Self

Sets the value of mime_type.

pub fn set_expiration<T>(self, v: T) -> Self

where T: Into<Duration>,

Sets the value of expiration.

pub fn set_or_clear_expiration<T>(self, v: Option<T>) -> Self

where T: Into<Duration>,

Sets or clears the value of expiration.

pub fn set_require_matching_file<T: Into<bool>>(self, v: T) -> Self

Sets the value of require_matching_file.

pub fn set_application_readable<T: Into<bool>>(self, v: T) -> Self

Sets the value of application_readable.

Trait Implementations

impl Clone for StaticFilesHandler

fn clone(&self) -> StaticFilesHandler

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StaticFilesHandler

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

Formats the value using the given formatter.

impl Default for StaticFilesHandler

fn default() -> StaticFilesHandler

Returns the “default value” for a type.

impl Message for StaticFilesHandler

fn typename() -> &'static str

The typename of this message.

impl PartialEq for StaticFilesHandler

fn eq(&self, other: &StaticFilesHandler) -> 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 StructuralPartialEq for StaticFilesHandler