Struct popcap_pak::Entry

pub struct Entry<'a> { /* private fields */ }

An Entry, representative of a file inside a pakfile.

Implementations

impl<'a> Entry<'a>

pub fn dir(&self) -> Option<&[u8]>

Get the directory of the file, or None if it doesn’t exist.

pub fn dir_str(&self) -> Option<Result<&str, Utf8Error>>

The same as Self::dir, but tries to make the byte slice a str.

This is provided as most paths are ascii.

pub fn name(&self) -> &[u8]

Get the name of the file.

pub fn name_str(&self) -> Result<&str, Utf8Error>

The same as Self::name, but tries to make the byte slice a str.

This is provided as most paths are ascii.

pub fn path(&self) -> &[u8]

Get the entire path of the file.

pub fn path_str(&self) -> Result<&str, Utf8Error>

The same as Self::path, but tries to make the byte slice a str.

This is provided as most paths are ascii.

pub fn file_time(&self) -> FileTime

Get the FileTime.

This represents access and modification time; there is no distinction.

pub fn iter_data(&self) -> impl Iterator<Item = u8> + '_

Get an iterator over all the bytes in the file.

pub fn is_borrowed(&self) -> bool

Check if the file is borrowed aka does not own its data.

pub fn size(&self) -> usize

Get the filesize.

pub fn into_owned(self) -> Entry<'static>

Decrypt the data and take ownership if it is borrowed.

Position data of the file is lost.

Trait Implementations

impl<'a> Debug for Entry<'a>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Entry<'a>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> Read for Entry<'a>

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

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>

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

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

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

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

Read 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)

Read 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.