Struct PuffinWriter 

pub struct PuffinWriter<W: Write + Seek> { /* private fields */ }

Streaming writer for Puffin files.

Wraps any Write + Seek sink. The magic header is written lazily on the first blob (or finish); call PuffinWriter::finish to flush the footer and recover the inner writer.

Examples

use std::io::Cursor;
use samkhya_core::puffin::{Blob, PuffinReader, PuffinWriter};

let mut writer = PuffinWriter::new(Cursor::new(Vec::<u8>::new()));
writer.add_blob(Blob::new("samkhya.test-v1", vec![0], b"hello")).unwrap();
let cursor = writer.finish().unwrap();

// Round-trip: open the bytes back as a reader.
let reader = PuffinReader::open(Cursor::new(cursor.into_inner())).unwrap();
assert_eq!(reader.blobs().len(), 1);

Implementations

impl<W: Write + Seek> PuffinWriter<W>

pub fn new(inner: W) -> Self

pub fn add_blob(&mut self, blob: Blob<'_>) -> Result<()>

Append a blob to the file.

Examples

use std::io::Cursor;
use samkhya_core::puffin::{Blob, PuffinWriter};

let mut writer = PuffinWriter::new(Cursor::new(Vec::<u8>::new()));
writer.add_blob(Blob::new("samkhya.test-v1", vec![0], b"payload")).unwrap();
let _bytes = writer.finish().unwrap().into_inner();

pub fn add_blob_compressed( &mut self, blob: Blob<'_>, codec: CompressionCodec, ) -> Result<()>

Append a blob with payload compressed under codec.

CompressionCodec::None is equivalent to Self::add_blob. CompressionCodec::Zstd requires the zstd feature; otherwise this returns an Error::InvalidPuffin explaining the missing feature.

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

Finalize the file: write the footer and return the inner writer.