Struct Builder 

pub struct Builder { /* private fields */ }

A builder for a cache.

Implementations

impl Builder

pub fn new() -> Self

Returns a new cache builder.

pub fn directory(self, directory: impl Into<PathBuf>) -> Self

Set the cache directory.

Defaults to {alfred_workflow_cache}/cache

These should be set by Alfred, but if not:

• {alfred_workflow_cache} defaults to ~/Library/Caches/com.runningwithcrayons.Alfred/Workflow Data/{alfred_workflow_bundleid}
• {alfred_workflow_bundleid} defaults to powerpack

See powerpack_env::workflow_cache_or_default for more information.

pub fn policy(self, query_policy: impl Into<FlagSet<QueryPolicy>>) -> Self

Set the query policy for the cache.

This is used to determine things like when updates should occur and stale data is allowed to be returned.

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

Set the default Time To Live (TTL) for the data in the cache.

This is used if the query does not specify a TTL.

If the data in the cache is older than this then the cache will be automatically refreshed. Stale data will be returned in the meantime.

Defaults to 60 seconds.

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

Set the initial poll duration.

This is used if the query does not specify an initial poll duration.

This is the duration to wait for the cache to be populated on the first call. If the cache is not populated within this duration, a miss error will be raised.

Defaults to not polling at all. This means the initial call to .query() will return immediately with Err(QueryError::Miss).

pub fn try_build(self) -> Result<Cache, BuildError>

Try build the cache.

This can fail if the user’s home directory cannot be determined.

pub fn build(self) -> Cache

Build the cache.

Panics

If the user’s home directory cannot be determined.

Trait Implementations

impl Clone for Builder

fn clone(&self) -> Builder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Builder

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

Formats the value using the given formatter.

impl Default for Builder

fn default() -> Self

Returns the “default value” for a type.