Skip to main content

CacheSettings

Struct CacheSettings 

Source
#[non_exhaustive]
pub struct CacheSettings { pub default_ttl_secs: Option<u64>, pub refresh_threshold: Option<f64>, pub lock_timeout_ms: Option<u64>, }
Expand description

Settings every store has. Each store’s settings flatten them, so in a config file they sit beside the store’s own: { "default_ttl_secs": 300, "max_entries": 10000 }.

Fields (Non-exhaustive)§

This struct is marked as 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.
§default_ttl_secs: Option<u64>

The TTL of a write that doesn’t set one: none by default. None keeps values until removed or evicted; validate rejects 0, which would expire every write at once.

§refresh_threshold: Option<f64>

The share of an entry’s TTL after which get_or_set reloads it ahead of expiry, such as 0.8: off by default. None turns refresh-ahead off; validate rejects a value outside (0, 1).

§lock_timeout_ms: Option<u64>

How long get_or_set waits for another caller’s load of the same key before it loads the value itself: 30 seconds by default. None waits until that load finishes, so a loader that hangs holds up every caller of its key for as long. validate rejects 0, which would let every caller load at once.

Implementations§

Source§

impl CacheSettings

Source

pub fn validate(&self) -> Result<(), CacheError>

Fails when default_ttl_secs or lock_timeout_ms is 0 or over MAX_TTL_SECS, or refresh_threshold is not between 0 and 1.

Source

pub fn default_ttl(&self) -> Option<Duration>

default_ttl_secs as a Duration, or None when a write without a TTL never expires.

Source

pub fn lock_timeout(&self) -> Option<Duration>

lock_timeout_ms as a Duration, or None to wait as long as the other load takes.

Trait Implementations§

Source§

impl Clone for CacheSettings

Source§

fn clone(&self) -> CacheSettings

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CacheSettings

Source§

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

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

impl Default for CacheSettings

Source§

fn default() -> CacheSettings

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

impl<'de> Deserialize<'de> for CacheSettings

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<CacheSettings, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for CacheSettings

Source§

fn eq(&self, other: &CacheSettings) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for CacheSettings

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for CacheSettings

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> CacheValue for T
where T: Any + Serialize + DeserializeOwned + Clone + Send + Sync + 'static,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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