Skip to main content

StreamingChunker

Struct StreamingChunker 

Source
pub struct StreamingChunker { /* private fields */ }
Expand description

Stateful streaming chunker – feeds data incrementally, emits chunks as boundaries are found.

Unlike chunk_slice() which needs the full data in memory, StreamingChunker processes data in arbitrary-sized reads and emits Chunk objects as gear-hash boundaries are detected.

§Example

let mut sc = StreamingChunker::new(&GearChunker::new(2048, 65536, 2097152).unwrap());
let mut file = std::fs::File::open("large_file.dat").unwrap();
let mut buf = [0u8; 1_048_576]; // 1MB read buffer
use std::io::Read;
loop {
    let n = file.read(&mut buf).unwrap();
    if n == 0 { break; }
    for chunk in sc.feed(&buf[..n]) {
        // Process each chunk (upload, hash, etc.)
    }
}
let (final_chunk, _file_hash) = sc.finish();

Implementations§

Source§

impl StreamingChunker

Source

pub fn new(chunker: &GearChunker) -> Self

Create a new streaming chunker from a GearChunker configuration.

Source

pub fn feed(&mut self, data: &[u8]) -> Vec<Chunk>

Feed data into the chunker and return any completed chunks.

Source

pub fn finish(self) -> (Option<Chunk>, Hash)

Finish the stream and return any trailing data as a final chunk.

Returns None if no data remains after the last boundary. Also returns the whole-file BLAKE3 hash.

Source

pub fn buffered(&self) -> usize

Get the current buffer size (bytes accumulated for current chunk).

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more