Struct SplitdirfdstreamReader 

pub struct SplitdirfdstreamReader<R> { /* private fields */ }

Reader for parsing a splitdirfdstream.

Yields Chunk values by parsing the binary format. The internal buffer is reused across calls so that only one chunk’s data is live at a time.

Example

use composefs_splitdirfdstream::{SplitdirfdstreamReader, Chunk};

// Manually constructed stream: Metadata "hello"
// Format: [0x00][5u32 LE][b"hello"]
let mut data = Vec::new();
data.push(0x00u8);
data.extend_from_slice(&5u32.to_le_bytes());
data.extend_from_slice(b"hello");

let mut reader = SplitdirfdstreamReader::new(data.as_slice());
assert_eq!(reader.next_chunk().unwrap(), Some(Chunk::Metadata(b"hello")));
assert_eq!(reader.next_chunk().unwrap(), None);

Implementations

impl<R: Read> SplitdirfdstreamReader<R>

pub fn new(reader: R) -> Self

Create a new reader wrapping reader.

pub fn into_inner(self) -> R

Consume this reader, returning the underlying Read impl.

pub fn next_chunk(&mut self) -> Result<Option<Chunk<'_>>>

Return the next chunk from the stream, or None at a clean EOF.

A clean EOF is one where zero bytes have been consumed from the current type byte. Any partial read (0 < n < expected) is Error::Truncated.

The returned Chunk::FileBackedData contains the raw filename bytes without any validation — callers that use filename directly must call validate_filename themselves, or use reconstruct which does it internally via open_beneath.

Errors

• Error::Truncated — stream ended mid-chunk
• Error::InlineTooLarge — Metadata or InlineData body size exceeds MAX_INLINE_CHUNK_SIZE
• Error::FilenameTooLong — filename length exceeds MAX_FILENAME_LEN
• Error::UnknownChunkType — unrecognised type byte
• Error::Io — underlying I/O error

Trait Implementations

impl<R: Debug> Debug for SplitdirfdstreamReader<R>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.