Struct ArchiveIteratorBuilder

Source

pub struct ArchiveIteratorBuilder<R>where
    R: Read + Seek,
{ /* private fields */ }

Implementations§

Source §

impl<R> ArchiveIteratorBuilder<R>
where R: Read + Seek,

A builder to generate an archive iterator over the contents of an archive, streaming the contents of each entry in small chunks. The default configuration is identical to ArchiveIterator::from_read.

§Example

use compress_tools::{ArchiveContents, ArchiveIteratorBuilder};
use std::path::Path;
use std::ffi::OsStr;

let source = std::fs::File::open("tests/fixtures/tree.tar").expect("Failed to open file");
let decode_utf8 = |bytes: &[u8]| Ok(std::str::from_utf8(bytes)?.to_owned());

for content in ArchiveIteratorBuilder::new(source)
    .decoder(decode_utf8)
    .filter(|name, stat| Path::new(name).file_name() == Some(OsStr::new("foo")) || stat.st_size == 42)
    .build()
    .expect("Failed to initialize archive")
    {
        if let ArchiveContents::StartOfEntry(name, _stat) = content {
            println!("{name}");
        }
    }

Source

pub fn new(source: R) -> ArchiveIteratorBuilder<R>

Create a new builder for an archive iterator. Default configuration is identical to ArchiveIterator::from_read.

Source

pub fn decoder(self, decoder: DecodeCallback) -> ArchiveIteratorBuilder<R>

Use a custom decoder to decode filenames of archive entries. By default an UTF-8 decoder (decode_utf8) is used.

Source

pub fn filter<F>(self, filter: F) -> ArchiveIteratorBuilder<R>
where F: Fn(&str, &stat) -> bool + 'static,

Use a filter to skip unwanted entries and their decompression. By default all entries are iterated.

Source

pub fn with_password( self, password: ArchivePassword, ) -> ArchiveIteratorBuilder<R>

Set a custom password to decode content of archive entries.

Source

pub fn raw_format(self, enable: bool) -> ArchiveIteratorBuilder<R>

Enable libarchive’s “raw” format handler, which parses any byte stream as a single-entry archive with pathname data.

Disabled by default so the iterator rejects input that isn’t a real archive. Enable it only when you intentionally want to iterate over arbitrary non-archive streams (e.g. a standalone gzip file).

Source

pub fn mtree_format(self, enable: bool) -> ArchiveIteratorBuilder<R>

Accept entries from libarchive’s “mtree” format handler (default).

libarchive’s mtree parser is permissive and will match free-form text (a plain gunzip’d text file is enough); pass false to reject those matches and error out instead.

Source