Struct WriteOpts

pub struct WriteOpts { /* private fields */ }

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

Implementations

impl WriteOpts

pub fn new() -> WriteOpts

Creates a blank set of cache writing options.

pub fn open<P, K>(self, cache: P, key: K) -> Result<Writer>

where P: AsRef<Path>, K: AsRef<str>,

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

pub fn open_hash<P>(self, cache: P) -> Result<Writer>

where P: AsRef<Path>,

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

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

Configures the algorithm to write data under.

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.

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

Sets arbitrary additional metadata to associate with the index entry.

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.

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.

Trait Implementations

impl Clone for WriteOpts

fn clone(&self) -> WriteOpts

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for WriteOpts

fn default() -> WriteOpts

Returns the “default value” for a type.