Struct nix_compat::nar::reader::DirReader

pub struct DirReader<'a, 'r> {
    reader: ArchiveReader<'a, 'r>,
    prev_name: Vec<u8>,
}

A directory iterator, yielding a sequence of Nodes. It must be fully consumed before reading further from the DirReader that produced it, if any.

Fields

reader: ArchiveReader<'a, 'r>

prev_name: Vec<u8>

Previous directory entry name. We have to hang onto this to enforce name monotonicity.

Implementations

impl<'a, 'r> DirReader<'a, 'r>

fn new(reader: ArchiveReader<'a, 'r>) -> Self

pub fn next(&mut self) -> Result<Option<Entry<'_, 'r>>>

Read the next Entry from the directory.

We explicitly don’t implement Iterator, since treating this as a regular Rust iterator will surely lead you astray.

• You must always consume the entire iterator, unless you abandon the entire archive reader.
• You must abandon the entire archive reader on the first error.
• You must abandon the directory reader upon the first None.
• Even if you know the amount of elements up front, you must keep reading until you encounter None.