CacheOptions

Struct CacheOptions 

Source
pub struct CacheOptions {
    pub ttl: Option<Duration>,
    pub policy: CachePolicy,
    pub write_policy: WritePolicy,
    pub tags: Vec<EntityTag>,
    pub max_size: Option<usize>,
    pub cache_empty: bool,
    pub bypass: bool,
    pub stale_while_revalidate: Option<Duration>,
}
Expand description

Options for caching a query result.

Fields§

§ttl: Option<Duration>

Time-to-live for the cached entry.

§policy: CachePolicy

Cache policy to use.

§write_policy: WritePolicy

Write policy (when to write to cache).

§tags: Vec<EntityTag>

Tags for invalidation.

§max_size: Option<usize>

Skip caching if result is larger than this size (bytes).

§cache_empty: bool

Whether to cache empty results.

§bypass: bool

Whether to bypass cache for this query.

§stale_while_revalidate: Option<Duration>

Stale-while-revalidate duration.

Implementations§

Source§

impl CacheOptions

Source

pub fn ttl(duration: Duration) -> Self

Create options with a specific TTL.

Source

pub fn no_expire() -> Self

Create options that don’t expire.

Source

pub fn bypass() -> Self

Create options that bypass the cache.

Source

pub fn with_ttl(self, duration: Duration) -> Self

Set the TTL.

Source

pub fn with_policy(self, policy: CachePolicy) -> Self

Set the cache policy.

Source

pub fn with_write_policy(self, policy: WritePolicy) -> Self

Set the write policy.

Source

pub fn with_tag(self, tag: impl Into<EntityTag>) -> Self

Add a tag.

Source

pub fn with_tags(self, tags: impl IntoIterator<Item = EntityTag>) -> Self

Add multiple tags.

Source

pub fn with_max_size(self, size: usize) -> Self

Set max size.

Source

pub fn no_size_limit(self) -> Self

Don’t limit size.

Source

pub fn no_cache_empty(self) -> Self

Don’t cache empty results.

Source

pub fn stale_while_revalidate(self, duration: Duration) -> Self

Enable stale-while-revalidate.

Source

pub fn short() -> Self

Short TTL preset (1 minute).

Source

pub fn medium() -> Self

Medium TTL preset (5 minutes).

Source

pub fn long() -> Self

Long TTL preset (1 hour).

Source

pub fn daily() -> Self

Very long TTL preset (1 day).

Trait Implementations§

Source§

impl Clone for CacheOptions

Source§

fn clone(&self) -> CacheOptions

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 CacheOptions

Source§

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

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

impl Default for CacheOptions

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