Struct StreamReader 

pub struct StreamReader<R: Read> { /* private fields */ }

Reads and parses a btrfs send stream.

Implementations

impl<R: Read> StreamReader<R>

pub fn new(reader: R) -> Result<Self, StreamError>

Read and validate the stream header, returning a new reader.

Errors

Returns an error if the header is truncated, the magic is invalid, or the stream version is unsupported.

Panics

Panics are unreachable: all unwrap() calls are on fixed-size slice-to-array conversions that always succeed.

pub fn version(&self) -> u32

Return the stream protocol version.

pub fn into_inner(self) -> R

Consume the underlying reader back out.

pub fn next_command(&mut self) -> Result<Option<StreamCommand>, StreamError>

Read the next command from the stream.

Returns Ok(None) on clean EOF (no more data), Ok(Some(End)) when the stream contains an explicit end-of-stream marker.

Errors

Returns an error on I/O failure, CRC mismatch, malformed TLV attributes, or unknown command types.

Panics

Panics are unreachable: all unwrap() calls are on fixed-size slice-to-array conversions that always succeed.

Trait Implementations

impl<R: Debug + Read> Debug for StreamReader<R>

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

Formats the value using the given formatter.