Struct kvarn::host::Options

source ·
pub struct Options {
    pub folder_default: Option<CompactString>,
    pub extension_default: Option<CompactString>,
    pub public_data_dir: Option<CompactString>,
    pub errors_dir: Option<CompactString>,
    pub disable_client_cache: bool,
    pub disable_if_modified_since: bool,
    pub status_code_cache_filter: fn(_: StatusCode) -> CacheAction,
    pub disable_fs: bool,
}
Expand description

Options for Host. Values wrapped in Options usually use hardcoded defaults when the value is None.

This can easily be cloned to be shared across multiple hosts.

Fields§

§folder_default: Option<CompactString>

Will be the default for folders; /js/ will resolve to /js/<folder_default>. E.g. /posts/ -> /posts/index.html

If no value is passed, index.html is assumed.

§extension_default: Option<CompactString>

Will be the default for unspecified file extensions; /foobar. will resolve to /foobar.<extension_default>. E.g. /index. -> /index.html

If no value is passed, html is assumed.

§public_data_dir: Option<CompactString>

Default data directory for public files. Default is public.

§errors_dir: Option<CompactString>

Default directory for overriding HTTP error responses. Default is errors.

§disable_client_cache: bool

Returns cache-control header to be no-store by default, if enabled.

Useful if you have a developing site and don’t want traditionally static content to be in the client cache.

§disable_if_modified_since: bool

Disables further caching by sending a StatusCode::NOT_MODIFIED when the if-modified-since header is sent and the resource is fresh.

§status_code_cache_filter: fn(_: StatusCode) -> CacheAction

Filter to not cache certain StatusCodes.

See CacheAction and default_status_code_cache_filter for more info.

§disable_fs: bool

Disables file system access for public files.

This still enables custom error messages and reading of files through extensions.

Implementations§

source§

impl Options

source

pub fn new() -> Self

Creates a new Options with default settings.

All Options are None and all booleans are false. Self::status_code_cache_filter uses default_status_code_cache_filter.

source

pub fn disable_client_cache(&mut self) -> &mut Self

Disables client cache on this host.

This makes all comprash::ClientCachePreferences no-store. Use Kvarn extensions’ force_cache to force certain files to cache.

source

pub fn disable_fs(&mut self) -> &mut Self

Disables accessing the file system for public files.

See Self::disable_fs for more info.

source

pub fn set_public_data_dir(&mut self, path: impl AsRef<str>) -> &mut Self

Sets the directory (relative to the Host::path) to fetch data for the web in. Defaults to public.

source

pub fn set_errors_dir(&mut self, path: impl AsRef<str>) -> &mut Self

Sets the directory (relative to the Host::path) to get HTTP error overrides from. Defaults to errors.

source

pub fn get_folder_default(&self) -> &str

Gets the Self::folder_default, as used by Kvarn. Uses the default specified there.

source

pub fn get_extension_default(&self) -> &str

Gets the Self::extension_default, as used by Kvarn. Uses the default specified there.

source

pub fn get_public_data_dir(&self) -> &str

Gets the Self::public_data_dir, as used by Kvarn. Uses the default specified there.

source

pub fn get_errors_dir(&self) -> &str

Gets the Self::errors_dir, as used by Kvarn. Uses the default specified there.

Trait Implementations§

source§

impl Clone for Options

source§

fn clone(&self) -> Options

Returns a copy 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 Options

source§

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

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

impl Default for Options

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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.

§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

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

§

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>,

§

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>,

§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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