Skip to main content

ZipArchive

Struct ZipArchive 

Source
pub struct ZipArchive<'a> { /* private fields */ }
Expand description

A parsed ZIP archive. Construction finds the end-of-central-directory record and parses the whole central directory; payload bytes are only touched by ZipArchive::extract.

Implementations§

Source§

impl<'a> ZipArchive<'a>

Source

pub fn new(data: &'a [u8]) -> Result<Self>

Parses data as a ZIP archive: finds the EOCD (searching backwards over a comment of up to 64 KiB), checks the single-disk and non-ZIP64 invariants, and parses every central directory entry.

The directory must sit exactly where the EOCD says and end exactly where the EOCD starts; archives that smuggle extra bytes between directory entries are malformed by definition (APPNOTE §4.3.12).

Source

pub fn entries(&self) -> &[ZipEntry<'a>]

The central directory entries, in archive order.

Source

pub fn len(&self) -> usize

How many members the archive holds.

Source

pub fn is_empty(&self) -> bool

Whether the archive holds no members.

Source

pub fn by_name(&self, name: &str) -> Option<&ZipEntry<'a>>

The entry with this exact member name (byte-exact match — the archive’s own convention), or None.

Source

pub fn extract(&self, entry: &ZipEntry<'a>) -> Result<Vec<u8>>

Extracts entry and verifies it: sizes first, CRC-32 last. The entry must come from this archive’s entries or by_name — it carries offsets into self.data.

Extraction is refused with Error::Unsupported for encrypted entries and compression methods other than stored (0) and DEFLATE (8), and Error::BadValue when the local header disagrees with the central directory, a data descriptor’s numbers do not match the directory’s, the decompressed length is wrong, or the CRC-32 does not match.

Source

pub fn extract_by_name(&self, name: &str) -> Result<Vec<u8>>

Extracts the named entry: Error::BadValue ("no such zip entry") when the name is absent, otherwise exactly extract.

Source

pub fn extract_with( &self, entry: &ZipEntry<'a>, limits: &Limits, ) -> Result<Vec<u8>>

extract with an explicit decompression ceiling. limits.max_output also bounds stored entries: an archive can claim any uncompressed size it likes and the ceiling keeps the reader’s promise for free.

Trait Implementations§

Source§

impl<'a> Clone for ZipArchive<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<'a> Debug for ZipArchive<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for ZipArchive<'a>

§

impl<'a> RefUnwindSafe for ZipArchive<'a>

§

impl<'a> Send for ZipArchive<'a>

§

impl<'a> Sync for ZipArchive<'a>

§

impl<'a> Unpin for ZipArchive<'a>

§

impl<'a> UnsafeUnpin for ZipArchive<'a>

§

impl<'a> UnwindSafe for ZipArchive<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.