pub struct ZipFileEntry<'a> { /* private fields */ }Expand description
A struct for reading a zip file, without a reader
Implementations§
Source§impl<'a> ZipFileEntry<'a>
impl<'a> ZipFileEntry<'a>
Sourcepub fn name_raw(&self) -> &[u8] ⓘ
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.
Sourcepub fn name(&self) -> ZipResult<Cow<'_, str>>
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.
Sourcepub fn mangled_name(&self) -> ZipResult<PathBuf>
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.
Sourcepub fn enclosed_name(&self) -> Option<PathBuf>
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/../baris fine,foo/../../baris 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.
Sourcepub fn header_start(&self) -> u64
pub fn header_start(&self) -> u64
Get the starting offset of the zip header for this file
Sourcepub fn central_header_start(&self) -> u64
pub fn central_header_start(&self) -> u64
Get the starting offset of the zip header in the central directory for this file
Sourcepub fn version_made_by(&self) -> (u8, u8)
pub fn version_made_by(&self) -> (u8, u8)
Get the version of the file
Sourcepub fn version_needed(&self) -> u16
pub fn version_needed(&self) -> u16
PKZIP version needed to open this file (from APPNOTE 4.4.3.2).
Sourcepub fn comment_raw(&self) -> &[u8] ⓘ
pub fn comment_raw(&self) -> &[u8] ⓘ
Get the comment of the file, in the raw (internal) byte representation.
These are the bytes as stored in the central directory, before ZipFile::comment
decodes them (as UTF-8 or CP437, depending on the language encoding flag) or replaces
them with an Info-ZIP Unicode Comment extra field.
Sourcepub fn external_attributes(&self) -> u32
pub fn external_attributes(&self) -> u32
Get the external attributes of the file
Sourcepub fn flags(&self) -> ZipFileFlags
pub fn flags(&self) -> ZipFileFlags
Get the flags of the file
Sourcepub fn compression(&self) -> CompressionMethod
pub fn compression(&self) -> CompressionMethod
Get the compression method used to store the file
Sourcepub fn compressed_size(&self) -> u64
pub fn compressed_size(&self) -> u64
Get the size of the file, in bytes, in the archive
Sourcepub fn last_modified(&self) -> Option<DateTime>
pub fn last_modified(&self) -> Option<DateTime>
Get the time the file was last modified
Sourcepub fn is_symlink(&self) -> bool
pub fn is_symlink(&self) -> bool
Returns whether the file is actually a symbolic link
Sourcepub fn is_file(&self) -> bool
pub fn is_file(&self) -> bool
Returns whether the file is a normal file (i.e. not a directory or symlink)
Sourcepub fn is_read_only(&self) -> bool
pub fn is_read_only(&self) -> bool
Returns whether the file is read-only. (On Unix, this means it’s not readable by anyone.)
Sourcepub fn with_reader<R: Read + Seek>(
self,
reader: &'a mut R,
options: ZipReadOptions<'_>,
) -> ZipResult<ZipFile<'a, R>>
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>
impl<'a> Debug for ZipFileEntry<'a>
Source§impl<'a> From<ZipFileEntry<'a>> for OwnedZipFileEntry
impl<'a> From<ZipFileEntry<'a>> for OwnedZipFileEntry
Source§fn from(entry: ZipFileEntry<'a>) -> Self
fn from(entry: ZipFileEntry<'a>) -> Self
Source§impl HasZipMetadata for ZipFileEntry<'_>
impl HasZipMetadata for ZipFileEntry<'_>
Source§fn get_metadata(&self) -> &ZipFileData
fn get_metadata(&self) -> &ZipFileData
Auto Trait Implementations§
impl<'a> !Freeze for ZipFileEntry<'a>
impl<'a> Forget for ZipFileEntry<'a>
impl<'a> Move 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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more