Struct otter_nodejs_tests::bundles::IndexedZip

pub struct IndexedZip { /* private fields */ }

Implementations

impl IndexedZip

pub fn new(file: File) -> Result<IndexedZip, LoadError>

pub fn by_name_caseless<S>(
    &'a mut self,
    name: S
) -> Result<Option<ZipFile<'a>>, LoadError> where
    S: Into<String>, 

Methods from Deref<Target = ZipArchive<BufReader<File>>>

pub fn extract<P>(&mut self, directory: P) -> Result<(), ZipError> where
    P: AsRef<Path>, 

Extract a Zip archive into a directory, overwriting files if they already exist. Paths are sanitized with ZipFile::enclosed_name.

Extraction is not atomic; If an error is encountered, some of the files may be left on disk.

pub fn len(&self) -> usize

Number of files contained in this zip.

pub fn is_empty(&self) -> bool

Whether this zip archive contains no files

pub fn offset(&self) -> u64

Get the offset from the beginning of the underlying reader that this zip begins at, in bytes.

Normally this value is zero, but if the zip has arbitrary data prepended to it, then this value will be the size of that prepended data.

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

Get the comment of the zip archive.

pub fn file_names(&self) -> impl Iterator<Item = &str>

Returns an iterator over all the file and directory names in this archive.

pub fn by_name_decrypt(
    &'a mut self,
    name: &str,
    password: &[u8]
) -> Result<Result<ZipFile<'a>, InvalidPassword>, ZipError>

Search for a file entry by name, decrypt with given password

Warning

The implementation of the cryptographic algorithms has not gone through a correctness review, and you should assume it is insecure: passwords used with this API may be compromised.

This function sometimes accepts wrong password. This is because the ZIP spec only allows us to check for a 1/256 chance that the password is correct. There are many passwords out there that will also pass the validity checks we are able to perform. This is a weakness of the ZipCrypto algorithm, due to its fairly primitive approach to cryptography.

pub fn by_name(&'a mut self, name: &str) -> Result<ZipFile<'a>, ZipError>

Search for a file entry by name

pub fn by_index_decrypt(
    &'a mut self,
    file_number: usize,
    password: &[u8]
) -> Result<Result<ZipFile<'a>, InvalidPassword>, ZipError>

Get a contained file by index, decrypt with given password

Warning

The implementation of the cryptographic algorithms has not gone through a correctness review, and you should assume it is insecure: passwords used with this API may be compromised.

This function sometimes accepts wrong password. This is because the ZIP spec only allows us to check for a 1/256 chance that the password is correct. There are many passwords out there that will also pass the validity checks we are able to perform. This is a weakness of the ZipCrypto algorithm, due to its fairly primitive approach to cryptography.

pub fn by_index(&mut self, file_number: usize) -> Result<ZipFile<'_>, ZipError>

Get a contained file by index

pub fn by_index_raw(
    &mut self,
    file_number: usize
) -> Result<ZipFile<'_>, ZipError>

Get a contained file by index without decompressing it

Trait Implementations

impl Debug for IndexedZip

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

Formats the value using the given formatter.

impl Deref for IndexedZip

type Target = ZipArchive<BufReader<File>>

The resulting type after dereferencing.

fn deref(&self) -> &<IndexedZip as Deref>::Target

Dereferences the value.

impl DerefMut for IndexedZip

fn deref_mut(&mut self) -> &mut <IndexedZip as Deref>::Target

Mutably dereferences the value.

impl<'z> IntoIterator for &'z IndexedZip

type Item = (&'z UniCase<String>, ZipIndex)

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = <&'z IndexedZip as IntoIterator>::Item> + 'z, Global>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'z IndexedZip as IntoIterator>::IntoIter

Creates an iterator from a value.