Struct rocket::fs::rewrite::File

#[non_exhaustive]
pub struct File<'r> {
    pub path: Cow<'r, Path>,
    pub headers: HeaderMap<'r>,
}

A File response from a FileServer and a rewriter.

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: Cow<'r, Path>

The path to the file that FileServer will respond with.

headers: HeaderMap<'r>

A list of headers to be added to the generated response.

Implementations

impl<'r> File<'r>

pub fn new(path: impl Into<Cow<'r, Path>>) -> Self

A new File, with not additional headers.

pub fn checked<P: AsRef<Path>>(path: P) -> Self

A new File, with not additional headers.

Panics

Panics if the path does not exist.

pub fn map_path<F, P>(self, f: F) -> Self

where F: FnOnce(Cow<'r, Path>) -> P, P: Into<Cow<'r, Path>>,

Replace the path in self with the result of applying f to the path.

pub fn is_hidden(&self) -> bool

Returns true if the file is a dotfile. A dotfile is a file whose name or any directory in it’s path start with a period (.) and is considered hidden.

Windows Note

This does not check the file metadata on any platform, so hidden files on Windows will not be detected by this method.

pub fn is_visible(&self) -> bool

Returns true if the file is not hidden. This is the inverse of File::is_hidden().

Trait Implementations

impl<'r> Clone for File<'r>

fn clone(&self) -> File<'r>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'r> Debug for File<'r>

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

Formats the value using the given formatter.

impl<'r> From<File<'r>> for Rewrite<'r>

fn from(value: File<'r>) -> Self

Converts to this type from the input type.

impl Rewriter for File<'static>

fn rewrite<'r>( &self, _: Option<Rewrite<'r>>, _: &Request<'_>, ) -> Option<Rewrite<'r>>

Alter the Rewrite as needed.