Struct cacache::WriteOpts

source · [−]

pub struct WriteOpts { /* private fields */ }

Expand description

Builder for options and flags for opening a new cache file to write data into.

Implementations

source

impl WriteOpts

source

pub fn new() -> WriteOpts

Creates a blank set of cache writing options.

source

pub async fn open<P, K>(self, cache: P, key: K) -> Result<Writer> where
P: AsRef<Path>,
K: AsRef<str>,

Opens the file handle for writing, returning an Writer instance.

source

pub async fn open_hash(self, cache: P) -> Result<Writer> where
P: AsRef<Path>,

Opens the file handle for writing, without a key returning an Writer instance.

source

pub fn open_sync<P, K>(self, cache: P, key: K) -> Result<SyncWriter> where
P: AsRef<Path>,
K: AsRef<str>,

Opens the file handle for writing synchronously, returning a SyncWriter instance.

source

pub fn open_hash_sync(self, cache: P) -> Result<SyncWriter> where
P: AsRef<Path>,

Opens the file handle for writing, without a key returning an SyncWriter instance.

source

pub fn algorithm(self, algo: Algorithm) -> Self

Configures the algorithm to write data under.

source

pub fn size(self, size: usize) -> Self

Sets the expected size of the data to write. If there’s a date size mismatch, put.commit() will return an error.

source

pub fn metadata(self, metadata: Value) -> Self

Sets arbitrary additional metadata to associate with the index entry.

source

pub fn time(self, time: u128) -> Self

Sets the specific time in unix milliseconds to associate with this entry. This is usually automatically set to the write time, but can be useful to change for tests and such.

source

pub fn integrity(self, sri: Integrity) -> Self

Sets the expected integrity hash of the written data. If there’s a mismatch between this Integrity and the one calculated by the write, put.commit() will error.