Skip to main content

ZipFileEntry

Struct ZipFileEntry 

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

A struct for reading a zip file, without a reader

Implementations§

Source§

impl<'a> ZipFileEntry<'a>

Source

pub fn name_raw(&self) -> &[u8] ⓘ

Get the name of the file, in the raw (internal) byte representation.

The encoding of this data is currently undefined.

Source

pub fn name(&self) -> ZipResult<Cow<'_, str>>

Get the name of the file

§Warnings

It is dangerous to use this name directly when extracting an archive. It may contain an absolute path (/etc/shadow), or break out of the current directory (../runtime). Carelessly writing to these paths allows an attacker to craft a ZIP archive that will overwrite critical files.

You can use the ZipFile::enclosed_name method to validate the name as a safe path.

Source

pub fn mangled_name(&self) -> ZipResult<PathBuf>

Rewrite the path, ignoring any path components with special meaning.

  • Absolute paths are made relative
  • ParentDirs are ignored
  • Truncates the filename at a NULL byte

This is appropriate if you need to be able to extract something from any archive, but will easily misrepresent trivial paths like foo/../bar as foo/bar (instead of bar). Because of this, ZipFile::enclosed_name is the better option in most scenarios.

Source

pub fn enclosed_name(&self) -> Option<PathBuf>

Ensure the file path is safe to use as a Path.

  • It can’t contain NULL bytes
  • It can’t resolve to a path outside the current directory

    foo/../bar is fine, foo/../../bar is not.

  • It can’t be an absolute path

This will read well-formed ZIP files correctly, and is resistant to path-based exploits. It is recommended over ZipFile::mangled_name.

Source

pub fn header_start(&self) -> u64

Get the starting offset of the zip header for this file

Source

pub fn central_header_start(&self) -> u64

Get the starting offset of the zip header in the central directory for this file

Source

pub fn version_made_by(&self) -> (u8, u8)

Get the version of the file

Source

pub fn version_needed(&self) -> u16

PKZIP version needed to open this file (from APPNOTE 4.4.3.2).

Source

pub fn comment(&self) -> &str

Get the comment of the file

Source

pub fn system(&self) -> System

Get the system of the file

Source

pub fn external_attributes(&self) -> u32

Get the external attributes of the file

Source

pub fn flags(&self) -> ZipFileFlags

Get the flags of the file

Source

pub fn compression(&self) -> CompressionMethod

Get the compression method used to store the file

Source

pub fn encrypted(&self) -> bool

Get if the files is encrypted or not

Source

pub fn compressed_size(&self) -> u64

Get the size of the file, in bytes, in the archive

Source

pub fn size(&self) -> u64

Get the size of the file, in bytes, when uncompressed

Source

pub fn last_modified(&self) -> Option<DateTime>

Get the time the file was last modified

Source

pub fn is_dir(&self) -> bool

Returns whether the file is actually a directory

Returns whether the file is actually a symbolic link

Source

pub fn is_file(&self) -> bool

Returns whether the file is a normal file (i.e. not a directory or symlink)

Source

pub fn is_read_only(&self) -> bool

Returns whether the file is read-only. (On Unix, this means it’s not readable by anyone.)

Source

pub fn unix_mode(&self) -> Option<u32>

Get unix mode for the file

Source

pub fn crc32(&self) -> u32

Get the CRC32 hash of the original file

Source

pub fn with_reader<R: Read + Seek>( self, reader: &'a mut R, options: ZipReadOptions<'_>, ) -> ZipResult<ZipFile<'a, R>>

Create a readable

Trait Implementations§

Source§

impl<'a> Debug for ZipFileEntry<'a>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl HasZipMetadata for ZipFileEntry<'_>

Source§

fn get_metadata(&self) -> &ZipFileData

Get the file metadata

Auto Trait Implementations§

§

impl<'a> !Freeze for ZipFileEntry<'a>

§

impl<'a> RefUnwindSafe for ZipFileEntry<'a>

§

impl<'a> Send for ZipFileEntry<'a>

§

impl<'a> Sync for ZipFileEntry<'a>

§

impl<'a> Unpin for ZipFileEntry<'a>

§

impl<'a> UnsafeUnpin for ZipFileEntry<'a>

§

impl<'a> UnwindSafe for ZipFileEntry<'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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.