Struct FileEntry

pub struct FileEntry<T: Read> { /* private fields */ }

A FileEntry represents a file in an archive, along with its format and size. It can be used to read the file’s contents, and can also be used to visit the contents of an archive.

Example

This walks a nested tar file

use std::path::PathBuf;
use anyreader_walker::{FileEntry, AnyWalker, EntryDetails, FormatKind, ArchiveStack};
// Create a tar archive containing a nested tar archive, containing a nested zip archive
let tar_archive = tar_archive([
    ("test", b"Hello, world!".to_vec()),
    ("nested.tar", tar_archive([
        ("nested", b"Hello, nested!".to_vec()),
        ("nested2", b"Hello, nested2!".to_vec()),
        ("nested_zip", zip_archive([("nested3", "Hello, nested zip!")]))
    ])),
]);
let entry = FileEntry::from_bytes("archive.tar.gz", tar_archive).unwrap();

#[derive(Default)]
struct Visitor {
   names: Vec<PathBuf>,
   stack: ArchiveStack
};

impl AnyWalker for Visitor {
    fn visit_file_entry(&mut self, entry: &mut FileEntry<impl Read>) -> std::io::Result<()> {
        self.names.push(self.stack.nested_path().join(&entry.path()));
        Ok(())
    }

    fn begin_visit_archive(&mut self, details: &EntryDetails, format: FormatKind) -> std::io::Result<bool> {
        self.stack.push_archive(&details.path);
        Ok(true)
    }
    fn end_visit_archive(&mut self, details: EntryDetails, format: FormatKind) -> std::io::Result<()> {
       self.stack.pop_archive();
       Ok(())
   }
}

let mut visitor = Visitor::default();
visitor.walk(entry).unwrap();

let names = visitor.names.iter().map(|p| p.to_str().unwrap()).collect::<Vec<_>>();
assert_eq!(names, [
    "archive.tar.gz/test",
    "archive.tar.gz/nested.tar/nested",
    "archive.tar.gz/nested.tar/nested2",
    "archive.tar.gz/nested.tar/nested_zip/nested3"
]);

Implementations

impl FileEntry<BufReader<File>>

pub fn from_path(path: impl AsRef<Path>) -> Result<Self>

Examples found in repository

examples/simple.rs (line 32)

fn main() {
    let entry = FileEntry::from_path("file.tar.gz").unwrap();
    let mut visitor = Visitor {};
    visitor.walk(entry).unwrap();
}

examples/count_files.rs (line 62)

fn main() -> std::io::Result<()> {
    let path = PathBuf::from(args().nth(1).unwrap());
    println!("{path:?}");

    let mut elapsed = Duration::from_secs(0);

    let mut visitor = Visitor::default();

    for item in std::fs::read_dir(&path)? {
        let item = item?;
        let path = item.path();
        if path.is_dir() {
            continue;
        }
        let start = Instant::now();
        let entry = FileEntry::from_path(path.clone())?;
        visitor.walk(entry)?;
        elapsed += start.elapsed();
    }
    println!("Total files: {}", visitor.count);
    println!("Total size: {}", visitor.size);

    let elapsed = elapsed.as_secs_f64();
    println!("Elapsed: {:.3}s", elapsed);
    println!("Throughput: {:.3} files/s", visitor.count as f64 / elapsed);
    println!(
        "Throughput: {:.3} MB/s",
        visitor.size as f64 / elapsed / 1024.0 / 1024.0
    );

    let mut counts: Vec<_> = visitor.format_counts.into_iter().collect();
    counts.sort_by_key(|(_, count)| *count);

    for (format, count) in counts {
        println!("{:?}: {}", format, count);
    }

    Ok(())
}

impl FileEntry<Reader<Bytes>>

pub fn from_bytes( path: impl AsRef<Path>, data: impl Into<Bytes>, ) -> Result<FileEntry<Reader<Bytes>>>

impl<T: Read> FileEntry<T>

pub fn new(path: PathBuf, size: u64, format: AnyFormat<T>) -> Self

pub fn from_reader(path: PathBuf, size: u64, reader: T) -> Result<FileEntry<T>>

pub fn into_components(self) -> (EntryDetails, AnyFormat<T>)

pub fn details(&self) -> &EntryDetails

pub fn path(&self) -> &Path

Examples found in repository

examples/simple.rs (line 12)

    fn visit_file_entry(&mut self, entry: &mut FileEntry<impl Read>) -> std::io::Result<()> {
        eprintln!(
            "Found file with format {}: {}",
            entry.format(),
            entry.path().display()
        );
        Ok(())
    }

pub fn size(&self) -> u64

Examples found in repository

examples/count_files.rs (line 20)

    fn visit_file_entry(&mut self, entry: &mut FileEntry<impl Read>) -> std::io::Result<()> {
        self.count += 1;
        self.size += entry.size();
        self.format_counts
            .entry(entry.format())
            .and_modify(|c| *c += 1)
            .or_insert(1);
        Ok(())
    }

pub fn supports_recursion(&self) -> bool

pub fn format(&self) -> FormatKind

Examples found in repository

examples/simple.rs (line 11)

    fn visit_file_entry(&mut self, entry: &mut FileEntry<impl Read>) -> std::io::Result<()> {
        eprintln!(
            "Found file with format {}: {}",
            entry.format(),
            entry.path().display()
        );
        Ok(())
    }

examples/count_files.rs (line 22)

    fn visit_file_entry(&mut self, entry: &mut FileEntry<impl Read>) -> std::io::Result<()> {
        self.count += 1;
        self.size += entry.size();
        self.format_counts
            .entry(entry.format())
            .and_modify(|c| *c += 1)
            .or_insert(1);
        Ok(())
    }

pub fn get_ref(&self) -> &T

Trait Implementations

impl<T: Read> Debug for FileEntry<T>

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

Formats the value using the given formatter.

impl<T: Read> Read for FileEntry<T>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Reads all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Reads all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

🔬This is a nightly-only experimental API. (read_buf)

Reads the exact number of bytes required to fill cursor.

fn by_ref(&mut self) -> &mut Self

where Self: Sized,

Creates a “by reference” adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R>

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

where Self: Sized,

Creates an adapter which will read at most limit bytes from it.