Struct ZipStreamFileMetadata

pub struct ZipStreamFileMetadata(/* private fields */);

Additional metadata for the file.

Implementations

impl ZipStreamFileMetadata

pub fn name(&self) -> &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.

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.

pub fn mangled_name(&self) -> PathBuf

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

• Absolute paths are made relative
• std::path::Component::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.

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.

pub fn is_dir(&self) -> bool

Returns whether the file is actually a directory

pub fn is_file(&self) -> bool

Returns whether the file is a regular file

pub fn comment(&self) -> &str

Get the comment of the file

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

Get unix mode for the file

Trait Implementations

impl Debug for ZipStreamFileMetadata

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

Formats the value using the given formatter.