Struct TarStream 

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

A strict stream of POSIX-pax or GNU frames sourced from an underlying reader.

Implementations

impl<R> TarStream<R>

pub fn new(reader: R) -> Self

Creates a new TarStream from the given reader.

pub fn set_max_pax_extension_size(&mut self, max_pax_extension_size: u64)

Sets the maximum size accepted for each subsequent pax extension.

A local or global header that declares a larger payload is rejected before its payload is consumed. Setting the maximum to zero rejects every nonempty extension. Setting it to u64::MAX removes the per-extension bound; global extensions remain subject to their cumulative limit.

pub fn set_max_global_pax_extensions_size( &mut self, max_global_pax_extensions_size: u64, )

Sets the maximum cumulative size accepted for global pax extensions before one ordinary member.

The total resets after each ordinary member. A global header that would increase the pending total beyond this limit is rejected before its payload is consumed. Setting the maximum to zero rejects every nonempty global extension. Setting it to u64::MAX removes the cumulative bound; each extension remains subject to its individual limit.

pub fn set_allow_all_nul_numeric_fields(&mut self, allow: bool)

Sets whether wholly NUL numeric metadata fields may be accepted.

This compatibility option applies to mode, uid, gid, and mtime in both pax/ustar and GNU ordinary member headers. It is enabled by default. Disabling it requires each field to use a valid numeric encoding for its archive family.

pub fn set_max_gnu_extension_size(&mut self, max_gnu_extension_size: u64)

Sets the maximum size accepted for each GNU extension.

A GNU extension member that declares a larger payload is rejected before its payload is consumed. Setting the maximum to zero rejects every nonempty GNU extension member. Setting it to u64::MAX removes the per-extension bound.

pub fn format(&self) -> Option<ArchiveFormat>

Returns the selected archive family after the first header is read.

impl<R: AsyncRead + Unpin> TarStream<R>

pub async fn next_frame(&mut self) -> Result<Option<Frame>, FrameError>

Returns the next non-terminator physical archive frame.

Reaching the end of the archive returns None. A framing error fuses this reader, so every subsequent call also returns None. Cancelling this operation retains any partial block for the next call.