Struct Reader

pub struct Reader { /* private fields */ }

File handle for reading data synchronously.

Make sure to call get.check() when done reading to verify that the extracted data passes integrity verification.

Implementations

impl Reader

pub fn check(self) -> Result<Algorithm>

Checks that data read from disk passes integrity checks. Returns the algorithm that was used verified the data. Should be called only after all data has been read from disk.

Example

use std::io::Read;

fn main() -> cacache_sync::Result<()> {
    let mut fd = cacache_sync::Reader::open("./my-cache", "my-key")?;
    let mut str = String::new();
    fd.read_to_string(&mut str).expect("Failed to read to string");
    // Remember to check that the data you got was correct!
    fd.check()?;
    Ok(())
}

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

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

Opens a new synchronous file handle into the cache, looking it up in the index using key.

Example

use std::io::Read;

fn main() -> cacache_sync::Result<()> {
    let mut fd = cacache_sync::Reader::open("./my-cache", "my-key")?;
    let mut str = String::new();
    fd.read_to_string(&mut str).expect("Failed to parse string");
    // Remember to check that the data you got was correct!
    fd.check()?;
    Ok(())
}

pub fn open_hash<P>(cache: P, sri: Integrity) -> Result<Reader>

where P: AsRef<Path>,

Opens a new synchronous file handle into the cache, based on its integrity address.

Example

use std::io::Read;

fn main() -> cacache_sync::Result<()> {
    let sri = cacache_sync::write("./my-cache", "key", b"hello world")?;
    let mut fd = cacache_sync::Reader::open_hash("./my-cache", sri)?;
    let mut str = String::new();
    fd.read_to_string(&mut str).expect("Failed to read to string");
    // Remember to check that the data you got was correct!
    fd.check()?;
    Ok(())
}

Trait Implementations

impl Read for Reader

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

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

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

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

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

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.