Struct CacheOptions 

pub struct CacheOptions { /* private fields */ }

Per-entry cache behavior.

Options are passed to put, get_or_load, and loader helper methods.

Example

use std::time::Duration;

use hydracache_core::CacheOptions;

let options = CacheOptions::new()
    .ttl(Duration::from_secs(60))
    .tags(["users", "user:42"]);

assert_eq!(options.ttl_value(), Some(Duration::from_secs(60)));
assert_eq!(options.tags_value(), &["users".to_owned(), "user:42".to_owned()]);

Implementations

impl CacheOptions

pub fn new() -> Self

Create empty cache options.

pub fn ttl(self, ttl: Duration) -> Self

Set a per-entry TTL.

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

Attach one tag used by invalidate_tag.

pub fn tags<I, S>(self, tags: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Attach tags used by invalidate_tag.

pub fn tag_set(self, tags: TagSet) -> Self

Replace tags from a TagSet.

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

Return the configured TTL, if any.

pub fn tags_value(&self) -> &[String]

Return tags attached to this entry.

Trait Implementations

impl Clone for CacheOptions

fn clone(&self) -> CacheOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheOptions

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

Formats the value using the given formatter.

impl Default for CacheOptions

fn default() -> CacheOptions

Returns the “default value” for a type.

impl Eq for CacheOptions

impl PartialEq for CacheOptions

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CacheOptions