Struct bao::encode::SliceExtractor

pub struct SliceExtractor<T: Read + Seek, O: Read + Seek> { /* private fields */ }

An incremental slice extractor, which reads encoded bytes and produces a slice.

SliceExtractor supports reading both the combined and outboard encoding, depending on which constructor you use. Though to be clear, there’s no such thing as an “outboard slice” per se. Slices always include subtree hashes inline with the content, as a combined encoding does.

Note that slices always split the encoding at chunk boundaries. The BLAKE3 chunk size is 1024 bytes, so using slice_start and slice_len values that are an even multiple of 1024 avoids wasting space.

Extracting a slice doesn’t re-hash any of the bytes. As a result, it’s fast compared to decoding. You can quickly convert an outboard encoding to a combined encoding by “extracting” a slice with a slice_start of zero and a slice_len equal to the original input length.

See the decode module for decoding slices.

Example

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

let input = vec![0; 1_000_000];
let (encoded, hash) = bao::encode::encode(&input);
// These parameters are multiples of the chunk size, which avoids unnecessary overhead.
let slice_start = 65536;
let slice_len = 8192;
let encoded_cursor = std::io::Cursor::new(&encoded);
let mut extractor = bao::encode::SliceExtractor::new(encoded_cursor, slice_start, slice_len);
let mut slice = Vec::new();
extractor.read_to_end(&mut slice)?;

// The slice includes some overhead to store the necessary subtree hashes.
assert_eq!(9096, slice.len());

Implementations

impl<T: Read + Seek> SliceExtractor<T, T>

pub fn new(input: T, slice_start: u64, slice_len: u64) -> Self

Create a new SliceExtractor to read from a combined encoding. Note that slice_start and slice_len are with respect to the content of the encoding, that is, the original input bytes. This corresponds to bao slice slice_start slice_len.

impl<T: Read + Seek, O: Read + Seek> SliceExtractor<T, O>

pub fn new_outboard(
    input: T,
    outboard: O,
    slice_start: u64,
    slice_len: u64
) -> Self

Create a new SliceExtractor to read from an unmodified input file and an outboard encoding of that same file (see Encoder::new_outboard). As with SliceExtractor::new, slice_start and slice_len are with respect to the content of the encoding, that is, the original input bytes. This corresponds to bao slice slice_start slice_len --outboard.

pub fn into_inner(self) -> (T, Option<O>)

Return the underlying readers. The second reader is Some if and only if this SliceExtractor was created with new_outboard.

Trait Implementations

impl<T: Read + Seek, O: Read + Seek> Read for SliceExtractor<T, O>

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, Global>) -> Result<usize, Error>

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

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

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

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

Read the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: &mut ReadBuf<'_>) -> 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, buf: &mut ReadBuf<'_>) -> Result<(), Error>

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

Read the exact number of bytes required to fill buf.

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

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

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adapter which will chain this stream with another.

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

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