Struct forceps::Metadata

pub struct Metadata { /* fields omitted */ }

Metadata information about a certain entry in the cache

This metadata contains information about when the entry was last modified, the size (in bytes) of the entry, the md5 integrity of the entry, etc.

Examples

use forceps::Cache;

let cache = Cache::new("./cache")
    .build()
    .await
    .unwrap();

cache.write(&b"MY_KEY", &b"Hello World").await.unwrap();

let metadata = cache.read_metadata(&b"MY_KEY").unwrap();

Implementations

impl Metadata

pub fn get_size(&self) -> u64

The size in bytes of the corresponding cache entry.

pub fn get_last_modified(&self) -> Option<SystemTime>

Retrives the last time this entry was modified.

pub fn get_last_modified_raw(&self) -> u64

Retrieves the raw last_modified time, which is the milliseconds since time::UNIX_EPOCH. If the returned result is 0, that means there is no last_modified time.

pub fn get_hits(&self) -> u64

The total number of times this entry has been read.

NOTE: This will be 0 unless track_access is enabled from the CacheBuilder

pub fn get_last_acccessed(&self) -> Option<SystemTime>

Retrives the last time this entry was accessed (read from).

NOTE: This will be the same as get_last_modified unless track_access is enabled from the CacheBuilder

pub fn get_last_accessed_raw(&self) -> u64

Retrieves the raw last_accessed time, which is the milliseconds since time::UNIX_EPOCH. If the returned result is 0, that means there is no last_accessed time.

NOTE: This will be the same as get_last_modified_raw unless track_access is enabled from the CacheBuilder

pub fn get_integrity(&self) -> &Md5Bytes

Retrieves the internal Md5Bytes integrity of the corresponding metadata entry.

pub fn check_integrity_of(&self, data: &[u8]) -> bool

Verifies that the metadata integrity matches the integrity of the data provided.

Trait Implementations

impl Debug for Metadata

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Metadata

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Metadata

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

Serialize this value into the given Serde serializer.