Skip to main content

MemorySettings

Struct MemorySettings 

Source
#[non_exhaustive]
pub struct MemorySettings { pub purge_interval_secs: Option<u64>, pub max_entries: Option<usize>, pub shards: Option<usize>, }
Available on crate feature memory only.
Expand description

The memory store’s own settings, apart from the shared ones. A hybrid store’s local layer takes these too, under local.

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.
§purge_interval_secs: Option<u64>

How often the store drops its expired entries: 60 seconds by default. None turns that off, for an application that calls purge itself; validate rejects 0.

§max_entries: Option<usize>

The most entries the store holds. Past it, an insert starts a trim that drops expired entries, then the least recently used, down to about nine tenths of the limit. Inside a tokio runtime the trim runs on the blocking pool and inserts go on meanwhile, so the store can go over the limit while it runs; if they left it over, the trim runs again. None, the default, sets no limit; validate rejects 0.

§shards: Option<usize>

How many maps the entries are split over, each with its own lock: 16 by default. More maps let threads using different keys run side by side, and a remove_prefix, purge or trim holds up one map at a time instead of the whole store; each call then hashes its key once more. None means one map, a little faster for a store used from one thread; validate rejects 0 and more than 1,024.

Implementations§

Source§

impl MemorySettings

Source

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

Fails when a setting is 0, purge_interval_secs is over 365 days or shards is over 1,024.

Source

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

purge_interval_secs as a Duration, or None when the store doesn’t purge by itself.

Source

pub fn shards(&self) -> usize

How many maps shards asks for: 1 for None.

Trait Implementations§

Source§

impl Clone for MemorySettings

Source§

fn clone(&self) -> MemorySettings

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 MemorySettings

Source§

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

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

impl Default for MemorySettings

Source§

fn default() -> MemorySettings

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

impl<'de> Deserialize<'de> for MemorySettings

Source§

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

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

impl PartialEq for MemorySettings

Source§

fn eq(&self, other: &MemorySettings) -> 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 MemorySettings

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 MemorySettings

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