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

impl WriteOpts

pub fn new() -> WriteOpts

Creates a blank set of cache writing options.

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.

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

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

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.

pub fn open_hash_sync<P>(self, cache: P) -> Result<SyncWriter> 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 copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl Default for WriteOpts

fn default() -> WriteOpts

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl RefUnwindSafe for WriteOpts

impl Send for WriteOpts

impl Sync for WriteOpts

impl Unpin for WriteOpts

impl UnwindSafe for WriteOpts

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.