Skip to main content

ChunkedWriter

Struct ChunkedWriter 

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

A writer that processes data in chunks.

Implementations§

Source§

impl ChunkedWriter

Source

pub async fn from_file<P: AsRef<Path>>( path: P, strategy: ChunkStrategy, buffer_size: usize, max_concurrent_writes: usize, ) -> Result<Self>

Create a new chunked writer to a file.

Source

pub fn set_total_chunks(self, n: usize) -> Self

Declare the expected total number of chunks up front.

When finalize is called it verifies that exactly n chunks were written. A mismatch returns StreamingError::IncompleteFinalize.

Source

pub async fn write_chunk(&mut self, data: Bytes) -> Result<()>

Write a chunk of data.

Source

pub async fn write_chunks(&mut self, chunks: Vec<Bytes>) -> Result<()>

Write multiple chunks sequentially.

Source

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

Flush all pending writes.

Source

pub async fn finalize(self) -> Result<()>

Finalize the writer, validate chunk counts, and close the stream.

If set_total_chunks was called previously and the actual number of chunks written does not match the preset value, StreamingError::IncompleteFinalize is returned before the underlying I/O is closed so callers can inspect the partial output.

After a successful finalize a footer descriptor containing the real total_chunks value is appended so readers can discover the count without having to re-scan the file.

Source

pub fn chunks_written(&self) -> usize

Get the number of chunks written so far.

Source

pub fn bytes_written(&self) -> u64

Get the total bytes written so far.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

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

Initializes a with the given initializer. Read more
Source§

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

Dereferences the given pointer. Read more
Source§

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

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

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

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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