pub struct CacheControl { /* private fields */ }
Expand description

Directives to limit cache lifetime, read from cache-control and kvarn-cache-control headers.

See Self::from_cache_control and Self::from_kvarn_cache_control for respective parsing.

Implementations§

source§

impl CacheControl

source

pub fn from_cache_control( header: &str ) -> Result<CacheControl, CacheControlError>

Respects max-age= and no-store parts of cache-control header.

Uses the standard syntax.

Errors

Can return CacheControlError::MultipleMaxAge and CacheControlError::InvalidInteger.

source

pub fn from_kvarn_cache_control( header: &str ) -> Result<CacheControl, CacheControlError>

Converts a kvarn-cache-control header to a CacheControl directive.

The kvarn-cache-control header is used for reverse-proxy servers and other downstream sources to signal how Kvarn should cache their content. This header is prioritized over cache-control, but serves a similar function. This only applies to the server cache, whereas cache-control effects both the client and the server (if this header isn’t available).

See CacheControlError::InvalidUnit for available units.

Examples

To limit a response to be in the cache for 10 minutes, return kvarn-cache-control: 10m as a header in a reverse-proxied server or in a extension.

Errors

Can return CacheControlError::InvalidKeyword, CacheControlError::InvalidUnit, and CacheControlError::InvalidInteger.

source

pub fn from_headers( headers: &HeaderMap<HeaderValue> ) -> Result<CacheControl, CacheControlError>

Tries to get CacheControl from a HeaderMap.

See Self::from_kvarn_cache_control for more info about how the server cache directive is decided.

Errors

Same as Self::from_kvarn_cache_control and Self::from_cache_control with CacheControlError::InvalidBytes if HeaderValue::to_str returns an error.

source

pub fn store(&self) -> bool

Returns if you should cache.

source

pub fn as_freshness(&self) -> Option<u32>

Gets the freshness lifetime of this cache control directive. If the returned value is None, you should let it be in the cache for as long as possible, longer than any with a defined lifetime.

Trait Implementations§

source§

impl Clone for CacheControl

source§

fn clone(&self) -> CacheControl

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 CacheControl

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere T: 'a,

§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

§

impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere T: 'a,

§

fn implicit( self, class: Class, constructed: bool, tag: u32 ) -> TaggedParser<'a, Implicit, Self, E>

source§

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

const: unstable · 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 Twhere U: From<T>,

const: unstable · 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 = mem::align_of::<T>()

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

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere 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 Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
const: unstable · source§

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

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere 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