Skip to main content

StaticFilesConfig

Struct StaticFilesConfig 

Source
pub struct StaticFilesConfig {
    pub directory: PathBuf,
    pub prefix: String,
    pub index_files: Vec<String>,
    pub show_hidden: bool,
    pub follow_symlinks: bool,
    pub enable_etag: bool,
    pub enable_last_modified: bool,
    pub directory_listing: bool,
    pub not_found_page: Option<String>,
    pub extra_headers: Vec<(String, String)>,
}
Expand description

Configuration for static file serving.

Fields§

§directory: PathBuf

Root directory to serve files from.

§prefix: String

URL path prefix (e.g., “/static”).

§index_files: Vec<String>

Index files to look for in directories.

§show_hidden: bool

Whether to serve hidden files (starting with .).

§follow_symlinks: bool

Whether to follow symlinks.

§enable_etag: bool

Whether to generate ETag headers.

§enable_last_modified: bool

Whether to add Last-Modified headers.

§directory_listing: bool

Whether to enable directory listing.

§not_found_page: Option<String>

Custom 404 page path (relative to directory).

§extra_headers: Vec<(String, String)>

Additional headers to add to all responses.

Implementations§

Source§

impl StaticFilesConfig

Source

pub fn new(directory: impl Into<PathBuf>) -> Self

Create a new configuration with the given directory.

Source

pub fn prefix(self, prefix: impl Into<String>) -> Self

Set the URL path prefix.

Source

pub fn index_files(self, files: Vec<String>) -> Self

Set the index files to look for.

Source

pub fn show_hidden(self, show: bool) -> Self

Enable or disable showing hidden files.

Enable or disable following symlinks.

Source

pub fn enable_etag(self, enable: bool) -> Self

Enable or disable ETag generation.

Source

pub fn enable_last_modified(self, enable: bool) -> Self

Enable or disable Last-Modified headers.

Source

pub fn directory_listing(self, enable: bool) -> Self

Enable or disable directory listing.

Source

pub fn not_found_page(self, page: impl Into<String>) -> Self

Set a custom 404 page.

Source

pub fn header(self, name: impl Into<String>, value: impl Into<String>) -> Self

Add an extra header to all responses.

Trait Implementations§

Source§

impl Clone for StaticFilesConfig

Source§

fn clone(&self) -> StaticFilesConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StaticFilesConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for StaticFilesConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, _span: NoopSpan) -> Self

Instruments this future with a span (no-op when disabled).
Source§

fn in_current_span(self) -> Self

Instruments this future with the current span (no-op when disabled).
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ResponseProduces<T> for T