Struct SyncWriter

pub struct SyncWriter { /* private fields */ }

A reference to an open file writing to the cache.

Implementations

impl SyncWriter

pub fn create<P, K>(cache: P, key: K) -> Result<SyncWriter>

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

Creates a new writable file handle into the cache.

Example

use std::io::prelude::*;

fn main() -> cacache::Result<()> {
    let mut fd = cacache::SyncWriter::create("./my-cache", "my-key")?;
    fd.write_all(b"hello world").expect("Failed to write to cache");
    // Data is not saved into the cache until you commit it.
    fd.commit()?;
    Ok(())
}

pub fn create_with_algo<P, K>( algo: Algorithm, cache: P, key: K, ) -> Result<SyncWriter>

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

Creates a new writable file handle into the cache. Use this to customize the hashing algorithm.

Example

use std::io::prelude::*;

fn main() -> cacache::Result<()> {
    let mut fd = cacache::SyncWriter::create_with_algo(cacache::Algorithm::Xxh3, "./my-cache", "my-key")?;
    fd.write_all(b"hello world").expect("Failed to write to cache");
    // Data is not saved into the cache until you commit it.
    fd.commit()?;
    Ok(())
}

pub fn commit(self) -> Result<Integrity>

Closes the Writer handle and writes content and index entries. Also verifies data against size and integrity options, if provided. Must be called manually in order to complete the writing process, otherwise everything will be thrown out.

Trait Implementations

impl Write for SyncWriter

fn write(&mut self, buf: &[u8]) -> Result<usize>

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adapter for this instance of Write.