Struct CacheMeta 

pub struct CacheMeta(/* private fields */);

The cacheable response header and cache metadata

Implementations

impl CacheMeta

pub fn new( fresh_until: SystemTime, created: SystemTime, stale_while_revalidate_sec: u32, stale_if_error_sec: u32, header: ResponseHeader, ) -> CacheMeta

Create a CacheMeta from the given metadata and the response header

pub fn created(&self) -> SystemTime

When the asset was created/admitted to cache

pub fn updated(&self) -> SystemTime

The last time the asset was revalidated

This value will be the same as Self::created() if no revalidation ever happens

pub fn epoch(&self) -> SystemTime

The reference point for cache age. This represents the “starting point” for fresh_until.

This defaults to the updated timestamp but is overridden by the epoch_override field if set.

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

Get the epoch override for this asset

pub fn set_epoch_override(&mut self, epoch: SystemTime)

Set the epoch override for this asset

When set, this will be used as the reference point for calculating age and freshness instead of the updated time.

pub fn remove_epoch_override(&mut self)

Remove the epoch override for this asset

pub fn is_fresh(&self, time: SystemTime) -> bool

Is the asset still valid

pub fn fresh_sec(&self) -> u64

How long (in seconds) the asset should be fresh since its admission/revalidation

This is essentially the max-age value (or its equivalence). If an epoch override is set, it will be used as the reference point instead of the updated time.

pub fn fresh_until(&self) -> SystemTime

Until when the asset is considered fresh

pub fn age(&self) -> Duration

How old the asset is since its admission/revalidation

If an epoch override is set, it will be used as the reference point instead of the updated time.

pub fn stale_while_revalidate_sec(&self) -> u32

The stale-while-revalidate limit in seconds

pub fn stale_if_error_sec(&self) -> u32

The stale-if-error limit in seconds

pub fn serve_stale_while_revalidate(&self, time: SystemTime) -> bool

Can the asset be used to serve stale during revalidation at the given time.

NOTE: the serve stale functions do not check !is_fresh(time), i.e. the object is already assumed to be stale.

pub fn serve_stale_if_error(&self, time: SystemTime) -> bool

Can the asset be used to serve stale after error at the given time.

NOTE: the serve stale functions do not check !is_fresh(time), i.e. the object is already assumed to be stale.

pub fn disable_serve_stale(&mut self)

Disable serve stale for this asset

pub fn variance(&self) -> Option<HashBinary>

Get the variance hash of this asset

pub fn set_variance_key(&mut self, variance_key: HashBinary)

Set the variance key of this asset

pub fn set_variance(&mut self, variance: HashBinary)

Set the variance (hash) of this asset

pub fn remove_variance(&mut self)

Removes the variance (hash) of this asset

pub fn response_header(&self) -> &ResponseHeader

Get the response header in this asset

pub fn response_header_mut(&mut self) -> &mut ResponseHeader

Modify the header in this asset

pub fn extensions(&self) -> &Extensions

Expose the extensions to read

pub fn extensions_mut(&mut self) -> &mut Extensions

Expose the extensions to modify

pub fn response_header_copy(&self) -> ResponseHeader

Get a copy of the response header

pub fn headers(&self) -> &HMap

get all the headers of this asset

pub fn serialize(&self) -> Result<(Vec<u8>, Vec<u8>)>

Serialize this object

pub fn deserialize(internal: &[u8], header: &[u8]) -> Result<Self>

Deserialize from the binary format

Trait Implementations

impl Debug for CacheMeta

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

Formats the value using the given formatter.