Struct StoredZipEntry

pub struct StoredZipEntry { /* private fields */ }

An immutable store of data about how a ZIP entry is stored within a specific archive.

Besides storing archive independent information like the size and timestamp it can also be used to query information about how the entry is stored in an archive.

Implementations

impl StoredZipEntry

pub fn header_offset(&self) -> u64

Returns the offset in bytes to where the header of the entry starts.

pub fn header_size(&self) -> u64

Returns the combined size in bytes of the header, the filename, and any extra fields.

Note: This uses the extra field length stored in the central directory, which may differ from that stored in the local file header. See specification: https://github.com/Majored/rs-async-zip/blob/main/SPECIFICATION.md#732

Methods from Deref<Target = ZipEntry>

pub fn filename(&self) -> &ZipString

Returns the entry’s filename.

Note

This will return the raw filename stored during ZIP creation. If calling this method on entries retrieved from untrusted ZIP files, the filename should be sanitised before being used as a path to prevent directory traversal attacks.

pub fn compression(&self) -> Compression

Returns the entry’s compression method.

pub fn crc32(&self) -> u32

Returns the entry’s CRC32 value.

pub fn uncompressed_size(&self) -> u64

Returns the entry’s uncompressed size.

pub fn compressed_size(&self) -> u64

Returns the entry’s compressed size.

pub fn attribute_compatibility(&self) -> AttributeCompatibility

Returns the entry’s attribute’s host compatibility.

pub fn last_modification_date(&self) -> &ZipDateTime

Returns the entry’s last modification time & date.

pub fn internal_file_attribute(&self) -> u16

Returns the entry’s internal file attribute.

pub fn external_file_attribute(&self) -> u32

Returns the entry’s external file attribute

pub fn extra_fields(&self) -> &[ExtraField]

Returns the entry’s extra field data.

pub fn comment(&self) -> &ZipString

Returns the entry’s file comment.

pub fn unix_permissions(&self) -> Option<u16>

Returns the entry’s integer-based UNIX permissions.

Note

This will return None if the attribute host compatibility is not listed as Unix.

pub fn dir(&self) -> Result<bool>

Returns whether or not the entry represents a directory.

Trait Implementations

impl Clone for StoredZipEntry

fn clone(&self) -> StoredZipEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Deref for StoredZipEntry

type Target = ZipEntry

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.