Struct nuts_archive::Entry

pub struct Entry<'a, B: Backend> { /* private fields */ }

An entry of the archive.

An instance of Entry represents an entry of the archive.

You can traverse through the archive using the Entry::next() method. The first entry of the archive is returned by Archive::first().

Implementations

impl<'a, B: Backend> Entry<'a, B>

pub fn next(self) -> Option<ArchiveResult<Entry<'a, B>, B>>

Returns the next entry in the archive.

If this is the last entry None is returned, which means that there are no further entries available.

pub fn name(&self) -> &str

Returns the name of the entry.

pub fn size(&self) -> u64

Returns the size of the entry.

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

Reads data from the entry.

Reads up to buf.len() bytes and puts them into buf.

The methods returns the number of bytes actually read, which cannot be greater than the buf.len().

pub fn read_all(&mut self, buf: &mut [u8]) -> ArchiveResult<(), B>

Read the exact number of bytes required to fill buf

This function reads as many bytes as necessary to completely fill the specified buffer buf.

Errors

If this function encounters an “end of file” before completely filling the buffer, it returns an Error::UnexpectedEof error. The contents of buf are unspecified in this case.

pub fn read_vec(&mut self) -> ArchiveResult<Vec<u8>, B>

Reads all bytes until EOF and collects them into a Vec which is returned.