Struct cacache::put::PutOpts

pub struct PutOpts { /* fields omitted */ }

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

Methods

impl PutOpts

pub fn new() -> PutOpts

Creates a blank set of cache writing options.

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

Opens the file handle for writing, returning a Put 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.

pub fn chown(self, uid: Option<Uid>, gid: Option<Gid>) -> Self

Configures the uid and gid to write data as. Useful when dropping privileges while in sudo mode.

impl PutOpts

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

Opens the file handle for writing, returning a Put instance.

Trait Implementations

impl Clone for PutOpts

fn clone(&self) -> PutOpts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for PutOpts

fn default() -> PutOpts

Returns the "default value" for a type.