Struct ZipFilePath

pub struct ZipFilePath<'a>(/* private fields */);

Represents a file path within a Zip archive, as a borrowed byte slice.

File paths in Zip archives are not guaranteed to be UTF-8, and may contain relative paths that try and escape the zip or absolute paths.

Implementations

impl<'a> ZipFilePath<'a>

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

Creates a Zip file path from a byte slice.

pub fn as_bytes(&self) -> &'a [u8]

Return the raw bytes of the Zip file path.

WARNING: this may contain be an absolute path or contain a file path capable of zip slips. Prefer normalize.

pub fn is_dir(&self) -> bool

Returns true if the file path is a directory.

This is determined by the file path ending in a slash, but it’s a common convention as otherwise it would be an invalid file.

Examples

let path = ZipFilePath::new(b"dir/");
assert!(path.is_dir());

let path = ZipFilePath::new(b"dir/file.txt");
assert!(!path.is_dir());

pub fn normalize(&self) -> Result<Cow<'_, str>, Error>

Normalizes the Zip file path.

The normalization process includes:

• Attempting to interpret the path as UTF-8.
• Replacing backslashes (\) with forward slashes (/).
• Removing redundant slashes (e.g., //).
• Resolving relative path components (. and ..).
• Stripping leading slashes and parent directory traversals that would escape the archive’s root (e.g., /foo becomes foo, ../foo becomes foo).

In the case where no allocation needs to occur when normalizing, an original reference to the data is returned.

Examples

Basic path normalization:

let path = ZipFilePath::new(b"dir/test.txt");
assert_eq!(path.normalize().unwrap(), "dir/test.txt");

// Converts backslashes to forward slashes
let path = ZipFilePath::new(b"dir\\test.txt");
assert_eq!(path.normalize().unwrap(), "dir/test.txt");

// Removes redundant slashes
let path = ZipFilePath::new(b"dir//test.txt");
assert_eq!(path.normalize().unwrap(), "dir/test.txt");

Handling relative and absolute paths:

// Removes leading slashes
let path = ZipFilePath::new(b"/test.txt");
assert_eq!(path.normalize().unwrap(), "test.txt");

// Resolves current directory references
let path = ZipFilePath::new(b"./test.txt");
assert_eq!(path.normalize().unwrap(), "test.txt");

// Resolves parent directory references
let path = ZipFilePath::new(b"dir/../test.txt");
assert_eq!(path.normalize().unwrap(), "test.txt");

let path = ZipFilePath::new(b"a/b/c/d/../../test.txt");
assert_eq!(path.normalize().unwrap(), "a/b/test.txt");

let path = ZipFilePath::new(b"dir/");
assert_eq!(path.normalize().unwrap(), "dir/");

Invalid paths:

// Invalid UTF-8 sequences result in an error
let path = ZipFilePath::new(&[0xFF]);
assert!(path.normalize().is_err());

let path = ZipFilePath::new(&[b't', b'e', b's', b't', 0xFF]);
assert!(path.normalize().is_err());

Errors

• if the file path is not valid UTF-8.

Note that zip file names aren’t always UTF-8

Trait Implementations

impl<'a> Clone for ZipFilePath<'a>

fn clone(&self) -> ZipFilePath<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ZipFilePath<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for ZipFilePath<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a> Ord for ZipFilePath<'a>

fn cmp(&self, other: &ZipFilePath<'a>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq for ZipFilePath<'a>

fn eq(&self, other: &ZipFilePath<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd for ZipFilePath<'a>

fn partial_cmp(&self, other: &ZipFilePath<'a>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Copy for ZipFilePath<'a>

impl<'a> Eq for ZipFilePath<'a>

impl<'a> StructuralPartialEq for ZipFilePath<'a>