Struct cacache::Writer

pub struct Writer { /* private fields */ }

A reference to an open file writing to the cache.

Implementations

impl Writer

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

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

Creates a new writable file handle into the cache.

Example

use async_attributes;
use async_std::prelude::*;

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

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

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

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

Example

use async_attributes;
use async_std::prelude::*;

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

pub async 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 AsyncWrite for Writer

fn poll_write( self: Pin<&mut Self>, cx: &mut TaskContext<'_>, buf: &[u8] ) -> Poll<Result<usize>>

Attempt to write bytes from buf into the object.

fn poll_flush( self: Pin<&mut Self>, cx: &mut TaskContext<'_> ) -> Poll<Result<()>>

Attempt to flush the object, ensuring that any buffered data reach their destination.

fn poll_close( self: Pin<&mut Self>, cx: &mut TaskContext<'_> ) -> Poll<Result<()>>

Attempt to close the object.

fn poll_write_vectored( self: Pin<&mut Self>, cx: &mut Context<'_>, bufs: &[IoSlice<'_>] ) -> Poll<Result<usize, Error>>

Attempt to write bytes from bufs into the object using vectored IO operations.