Struct FileSystemCache 

pub struct FileSystemCache { /* private fields */ }

File system based cache

Stores cached values as files on disk. Each cache key maps to a file, with a companion metadata file tracking expiration.

Directory Structure

cache_dir/
├── rekor_public_key.cache
├── rekor_public_key.meta
├── fulcio_trust_bundle.cache
├── fulcio_trust_bundle.meta
└── ...

Example

use sigstore_cache::{FileSystemCache, CacheAdapter, CacheKey};
use std::time::Duration;

// Use default location
let cache = FileSystemCache::default_location()?;

// Or specify custom directory
let cache = FileSystemCache::new("/tmp/my-sigstore-cache")?;

// Cache a value
cache.set(
    CacheKey::RekorPublicKey,
    b"public-key-data",
    Duration::from_secs(86400)
).await?;

Implementations

impl FileSystemCache

pub fn new(cache_dir: impl AsRef<Path>) -> Result<Self>

Create a new file system cache at the specified directory

The directory will be created if it doesn’t exist when writing.

pub fn default_location() -> Result<Self>

Create a cache at the default platform-specific location

See default_cache_dir for the exact locations.

Warning: This cache is not namespaced by instance URL. If you use multiple Sigstore instances (e.g., production and staging), use FileSystemCache::for_instance instead to avoid cache collisions.

pub fn for_instance(base_url: &str) -> Result<Self>

Create a cache namespaced to a specific Sigstore instance URL

This creates a subdirectory based on the URL, preventing cache collisions when using multiple Sigstore instances (e.g., production vs staging).

Example

use sigstore_cache::FileSystemCache;

// Cache for production instance
let prod_cache = FileSystemCache::for_instance("https://sigstore.dev")?;

// Cache for staging instance (separate directory)
let staging_cache = FileSystemCache::for_instance("https://sigstage.dev")?;

pub fn production() -> Result<Self>

Create a cache for the Sigstore production instance

Equivalent to FileSystemCache::for_instance("https://sigstore.dev").

pub fn staging() -> Result<Self>

Create a cache for the Sigstore staging instance

Equivalent to FileSystemCache::for_instance("https://sigstage.dev").

Trait Implementations

impl CacheAdapter for FileSystemCache

fn get(&self, key: CacheKey) -> CacheGetFuture<'_>

Get a cached value by key

fn set(&self, key: CacheKey, value: &[u8], ttl: Duration) -> CacheOpFuture<'_>

Set a cached value with a TTL

fn remove(&self, key: CacheKey) -> CacheOpFuture<'_>

Remove a cached value

fn clear(&self) -> CacheOpFuture<'_>

Clear all cached values

impl Clone for FileSystemCache

fn clone(&self) -> FileSystemCache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileSystemCache

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

Formats the value using the given formatter.