Struct AsyncStreamingEncoder 

pub struct AsyncStreamingEncoder<W: AsyncWrite + Unpin> { /* private fields */ }

Available on crate features alloc and async-tokio only.

An async streaming encoder for writing items incrementally.

Uses tokio’s async IO traits for non-blocking encoding operations.

Example

use oxicode::streaming::AsyncStreamingEncoder;
use tokio::fs::File;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let file = File::create("output.bin").await?;
    let mut encoder = AsyncStreamingEncoder::new(file);

    for i in 0..1000u32 {
        encoder.write_item(&i).await?;
    }

    encoder.finish().await?;
    Ok(())
}

Implementations

impl<W: AsyncWrite + Unpin> AsyncStreamingEncoder<W>

pub fn new(writer: W) -> Self

Create a new async streaming encoder.

pub fn with_config(writer: W, config: StreamingConfig) -> Self

Create an async streaming encoder with custom configuration.

pub fn set_estimated_total(&mut self, total: u64)

Set the estimated total number of items (for progress reporting).

pub async fn write_item<T: Encode>(&mut self, item: &T) -> Result<()>

Write a single item to the stream asynchronously.

pub async fn write_all<T: Encode, I: IntoIterator<Item = T>>( &mut self, items: I, ) -> Result<()>

Write multiple items from an iterator asynchronously.

pub async fn finish(self) -> Result<W>

Finish the stream, writing any remaining data and the end marker.

pub fn progress(&self) -> &StreamingProgress

Get current progress.

pub fn get_ref(&self) -> &W

Get a reference to the underlying writer.