Struct zip::read::ZipFile

source · [−]

pub struct ZipFile<'a> { /* private fields */ }

Expand description

A struct for reading a zip file

Implementations

source

impl<'a> ZipFile<'a>

Methods for retrieving information on zip files

source

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

Get the version of the file

source

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.

source

pub fn name_raw(&self) -> &[u8]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [u8]`

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

The encoding of this data is currently undefined.

source

pub fn sanitized_name(&self) -> PathBuf

👎 Deprecated since 0.5.7:

by stripping ..s from the path, the meaning of paths can change. mangled_name can be used if this behaviour is desirable

Get the name of the file in a sanitized form. It truncates the name to the first NULL byte, removes a leading ‘/’ and removes ‘..’ parts.

source

pub fn mangled_name(&self) -> 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<&Path>

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 comment(&self) -> &str

Get the comment of the file

source

pub fn compression(&self) -> CompressionMethod

Get the compression method used to store the file

source

pub fn compressed_size(&self) -> u64

Get the size of the file in the archive

source

pub fn size(&self) -> u64

Get the size of the file when uncompressed

source

pub fn last_modified(&self) -> DateTime

Get the time the file was last modified

source

pub fn is_dir(&self) -> bool

Returns whether the file is actually a directory

source

pub fn is_file(&self) -> bool

Returns whether the file is a regular file

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 extra_data(&self) -> &[u8]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [u8]`

Get the extra data of the zip header for this file

source

pub fn data_start(&self) -> u64

Get the starting offset of the data of the compressed file

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

Trait Implementations

source

impl<'a> Drop for ZipFile<'a>

source

fn drop(&mut self)

Executes the destructor for this type. Read more

source

impl<'a> Read for ZipFile<'a>

source

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more

1.36.0 · source

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers. Read more

source

fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation. Read more

1.0.0 · source

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf. Read more

1.0.0 · source

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf. Read more

1.6.0 · source

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf. Read more

source

fn read_buf(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (read_buf)

Pull some bytes from this source into the specified buffer. Read more

source

fn read_buf_exact(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

🔬 This is a nightly-only experimental API. (read_buf)

Read the exact number of bytes required to fill buf. Read more

1.0.0 · source

fn by_ref(&mut self) -> &mut Self

Creates a “by reference” adaptor for this instance of Read. Read more

1.0.0 · source

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an Iterator over its bytes. Read more

1.0.0 · source

fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,

Creates an adapter which will chain this stream with another. Read more

1.0.0 · source

fn take(self, limit: u64) -> Take<Self>

Creates an adapter which will read at most limit bytes from it. Read more

Auto Trait Implementations

impl<'a> !RefUnwindSafe for ZipFile<'a>

impl<'a> !Send for ZipFile<'a>

impl<'a> !Sync for ZipFile<'a>

impl<'a> Unpin for ZipFile<'a>

impl<'a> !UnwindSafe for ZipFile<'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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · 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<R> ReadBytesExt for R where
R: Read + ?Sized,

source

fn read_u8(&mut self) -> Result<u8, Error>

Reads an unsigned 8 bit integer from the underlying reader. Read more

source

fn read_i8(&mut self) -> Result<i8, Error>

Reads a signed 8 bit integer from the underlying reader. Read more

source

fn read_u16<T>(&mut self) -> Result<u16, Error> where
T: ByteOrder,

Reads an unsigned 16 bit integer from the underlying reader. Read more

source

fn read_i16<T>(&mut self) -> Result<i16, Error> where
T: ByteOrder,

Reads a signed 16 bit integer from the underlying reader. Read more

source

fn read_u24<T>(&mut self) -> Result<u32, Error> where
T: ByteOrder,

Reads an unsigned 24 bit integer from the underlying reader. Read more

source

fn read_i24<T>(&mut self) -> Result<i32, Error> where
T: ByteOrder,

Reads a signed 24 bit integer from the underlying reader. Read more

source

fn read_u32<T>(&mut self) -> Result<u32, Error> where
T: ByteOrder,

Reads an unsigned 32 bit integer from the underlying reader. Read more

source

fn read_i32<T>(&mut self) -> Result<i32, Error> where
T: ByteOrder,

Reads a signed 32 bit integer from the underlying reader. Read more

source

fn read_u48<T>(&mut self) -> Result<u64, Error> where
T: ByteOrder,

Reads an unsigned 48 bit integer from the underlying reader. Read more

source

fn read_i48<T>(&mut self) -> Result<i64, Error> where
T: ByteOrder,

Reads a signed 48 bit integer from the underlying reader. Read more

source

fn read_u64<T>(&mut self) -> Result<u64, Error> where
T: ByteOrder,

Reads an unsigned 64 bit integer from the underlying reader. Read more

source

fn read_i64<T>(&mut self) -> Result<i64, Error> where
T: ByteOrder,

Reads a signed 64 bit integer from the underlying reader. Read more

source

fn read_u128<T>(&mut self) -> Result<u128, Error> where
T: ByteOrder,

Reads an unsigned 128 bit integer from the underlying reader. Read more

source

fn read_i128<T>(&mut self) -> Result<i128, Error> where
T: ByteOrder,

Reads a signed 128 bit integer from the underlying reader. Read more

source

fn read_uint<T>(&mut self, nbytes: usize) -> Result<u64, Error> where
T: ByteOrder,

Reads an unsigned n-bytes integer from the underlying reader. Read more

source

fn read_int<T>(&mut self, nbytes: usize) -> Result<i64, Error> where
T: ByteOrder,

Reads a signed n-bytes integer from the underlying reader. Read more

source

fn read_uint128<T>(&mut self, nbytes: usize) -> Result<u128, Error> where
T: ByteOrder,

Reads an unsigned n-bytes integer from the underlying reader.

source

fn read_int128<T>(&mut self, nbytes: usize) -> Result<i128, Error> where
T: ByteOrder,

Reads a signed n-bytes integer from the underlying reader.

source

fn read_f32<T>(&mut self) -> Result<f32, Error> where
T: ByteOrder,

Reads a IEEE754 single-precision (4 bytes) floating point number from the underlying reader. Read more

source

fn read_f64<T>(&mut self) -> Result<f64, Error> where
T: ByteOrder,

Reads a IEEE754 double-precision (8 bytes) floating point number from the underlying reader. Read more

source

fn read_u16_into<T>(&mut self, dst: &mut [u16]) -> Result<(), Error> where
T: ByteOrder,

Reads a sequence of unsigned 16 bit integers from the underlying reader. Read more

source

fn read_u32_into<T>(&mut self, dst: &mut [u32]) -> Result<(), Error> where
T: ByteOrder,

Reads a sequence of unsigned 32 bit integers from the underlying reader. Read more

source

fn read_u64_into<T>(&mut self, dst: &mut [u64]) -> Result<(), Error> where
T: ByteOrder,

Reads a sequence of unsigned 64 bit integers from the underlying reader. Read more

source

fn read_u128_into<T>(&mut self, dst: &mut [u128]) -> Result<(), Error> where
T: ByteOrder,

Reads a sequence of unsigned 128 bit integers from the underlying reader. Read more

source

fn read_i8_into(&mut self, dst: &mut [i8]) -> Result<(), Error>

Reads a sequence of signed 8 bit integers from the underlying reader. Read more

source

fn read_i16_into<T>(&mut self, dst: &mut [i16]) -> Result<(), Error> where
T: ByteOrder,

Reads a sequence of signed 16 bit integers from the underlying reader. Read more

source

fn read_i32_into<T>(&mut self, dst: &mut [i32]) -> Result<(), Error> where
T: ByteOrder,

Reads a sequence of signed 32 bit integers from the underlying reader. Read more

source

fn read_i64_into<T>(&mut self, dst: &mut [i64]) -> Result<(), Error> where
T: ByteOrder,

Reads a sequence of signed 64 bit integers from the underlying reader. Read more

source

fn read_i128_into<T>(&mut self, dst: &mut [i128]) -> Result<(), Error> where
T: ByteOrder,

Reads a sequence of signed 128 bit integers from the underlying reader. Read more

source

fn read_f32_into<T>(&mut self, dst: &mut [f32]) -> Result<(), Error> where
T: ByteOrder,

Reads a sequence of IEEE754 single-precision (4 bytes) floating point numbers from the underlying reader. Read more

source

fn read_f32_into_unchecked<T>(&mut self, dst: &mut [f32]) -> Result<(), Error> where
T: ByteOrder,

👎 Deprecated since 1.2.0:

please use read_f32_into instead

DEPRECATED. Read more

source

fn read_f64_into<T>(&mut self, dst: &mut [f64]) -> Result<(), Error> where
T: ByteOrder,

Reads a sequence of IEEE754 double-precision (8 bytes) floating point numbers from the underlying reader. Read more

source

fn read_f64_into_unchecked<T>(&mut self, dst: &mut [f64]) -> Result<(), Error> where
T: ByteOrder,

👎 Deprecated since 1.2.0:

please use read_f64_into instead

DEPRECATED. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct zip::read::ZipFile

Implementations

impl<'a> ZipFile<'a>

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

pub fn name(&self) -> &str

Warnings

pub fn name_raw(&self) -> &[u8]ⓘNotable traits for &[u8]impl Read for &[u8]impl Write for &mut [u8]

pub fn sanitized_name(&self) -> PathBuf

pub fn mangled_name(&self) -> PathBuf

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

pub fn comment(&self) -> &str

pub fn compression(&self) -> CompressionMethod

pub fn compressed_size(&self) -> u64

pub fn size(&self) -> u64

pub fn last_modified(&self) -> DateTime

pub fn is_dir(&self) -> bool

pub fn is_file(&self) -> bool

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

pub fn crc32(&self) -> u32

pub fn extra_data(&self) -> &[u8]ⓘNotable traits for &[u8]impl Read for &[u8]impl Write for &mut [u8]

pub fn data_start(&self) -> u64

pub fn header_start(&self) -> u64

pub fn central_header_start(&self) -> u64

Trait Implementations

impl<'a> Drop for ZipFile<'a>

fn drop(&mut self)

impl<'a> Read for ZipFile<'a>

fn read(&mut self, buf: &mut [u8]) -> Result<usize>

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

fn is_read_vectored(&self) -> bool

fn read_to_end(&mut self, buf: &mut Vec<u8, Global>) -> Result<usize, Error>

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

fn read_buf(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

fn read_buf_exact(&mut self, buf: &mut ReadBuf<'_>) -> Result<(), Error>

fn by_ref(&mut self) -> &mut Self

fn bytes(self) -> Bytes<Self>

fn chain<R>(self, next: R) -> Chain<Self, R> where R: Read,

fn take(self, limit: u64) -> Take<Self>

Auto Trait Implementations

impl<'a> !RefUnwindSafe for ZipFile<'a>

impl<'a> !Send for ZipFile<'a>

impl<'a> !Sync for ZipFile<'a>

impl<'a> Unpin for ZipFile<'a>

impl<'a> !UnwindSafe for ZipFile<'a>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<R> ReadBytesExt for R where R: Read + ?Sized,

fn read_u8(&mut self) -> Result<u8, Error>

fn read_i8(&mut self) -> Result<i8, Error>

fn read_u16<T>(&mut self) -> Result<u16, Error> where T: ByteOrder,

fn read_i16<T>(&mut self) -> Result<i16, Error> where T: ByteOrder,

fn read_u24<T>(&mut self) -> Result<u32, Error> where T: ByteOrder,

fn read_i24<T>(&mut self) -> Result<i32, Error> where T: ByteOrder,

fn read_u32<T>(&mut self) -> Result<u32, Error> where T: ByteOrder,

fn read_i32<T>(&mut self) -> Result<i32, Error> where T: ByteOrder,

fn read_u48<T>(&mut self) -> Result<u64, Error> where T: ByteOrder,

fn read_i48<T>(&mut self) -> Result<i64, Error> where T: ByteOrder,

fn read_u64<T>(&mut self) -> Result<u64, Error> where T: ByteOrder,

fn read_i64<T>(&mut self) -> Result<i64, Error> where T: ByteOrder,

fn read_u128<T>(&mut self) -> Result<u128, Error> where T: ByteOrder,

fn read_i128<T>(&mut self) -> Result<i128, Error> where T: ByteOrder,

fn read_uint<T>(&mut self, nbytes: usize) -> Result<u64, Error> where T: ByteOrder,

fn read_int<T>(&mut self, nbytes: usize) -> Result<i64, Error> where T: ByteOrder,

fn read_uint128<T>(&mut self, nbytes: usize) -> Result<u128, Error> where T: ByteOrder,

fn read_int128<T>(&mut self, nbytes: usize) -> Result<i128, Error> where T: ByteOrder,

fn read_f32<T>(&mut self) -> Result<f32, Error> where T: ByteOrder,

fn read_f64<T>(&mut self) -> Result<f64, Error> where T: ByteOrder,

fn read_u16_into<T>(&mut self, dst: &mut [u16]) -> Result<(), Error> where T: ByteOrder,

fn read_u32_into<T>(&mut self, dst: &mut [u32]) -> Result<(), Error> where T: ByteOrder,

fn read_u64_into<T>(&mut self, dst: &mut [u64]) -> Result<(), Error> where T: ByteOrder,

pub fn name_raw(&self) -> &[u8]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [u8]`

pub fn extra_data(&self) -> &[u8]ⓘNotable traits for &[u8]`impl Read for &[u8]impl Write for &mut [u8]`

fn chain<R>(self, next: R) -> Chain<Self, R> where
R: Read,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<R> ReadBytesExt for R where
R: Read + ?Sized,

fn read_u16<T>(&mut self) -> Result<u16, Error> where
T: ByteOrder,

fn read_i16<T>(&mut self) -> Result<i16, Error> where
T: ByteOrder,

fn read_u24<T>(&mut self) -> Result<u32, Error> where
T: ByteOrder,

fn read_i24<T>(&mut self) -> Result<i32, Error> where
T: ByteOrder,

fn read_u32<T>(&mut self) -> Result<u32, Error> where
T: ByteOrder,

fn read_i32<T>(&mut self) -> Result<i32, Error> where
T: ByteOrder,

fn read_u48<T>(&mut self) -> Result<u64, Error> where
T: ByteOrder,

fn read_i48<T>(&mut self) -> Result<i64, Error> where
T: ByteOrder,

fn read_u64<T>(&mut self) -> Result<u64, Error> where
T: ByteOrder,

fn read_i64<T>(&mut self) -> Result<i64, Error> where
T: ByteOrder,

fn read_u128<T>(&mut self) -> Result<u128, Error> where
T: ByteOrder,

fn read_i128<T>(&mut self) -> Result<i128, Error> where
T: ByteOrder,

fn read_uint<T>(&mut self, nbytes: usize) -> Result<u64, Error> where
T: ByteOrder,

fn read_int<T>(&mut self, nbytes: usize) -> Result<i64, Error> where
T: ByteOrder,

fn read_uint128<T>(&mut self, nbytes: usize) -> Result<u128, Error> where
T: ByteOrder,

fn read_int128<T>(&mut self, nbytes: usize) -> Result<i128, Error> where
T: ByteOrder,

fn read_f32<T>(&mut self) -> Result<f32, Error> where
T: ByteOrder,

fn read_f64<T>(&mut self) -> Result<f64, Error> where
T: ByteOrder,

fn read_u16_into<T>(&mut self, dst: &mut [u16]) -> Result<(), Error> where
T: ByteOrder,

fn read_u32_into<T>(&mut self, dst: &mut [u32]) -> Result<(), Error> where
T: ByteOrder,

fn read_u64_into<T>(&mut self, dst: &mut [u64]) -> Result<(), Error> where
T: ByteOrder,

fn read_u128_into<T>(&mut self, dst: &mut [u128]) -> Result<(), Error> where
T: ByteOrder,

fn read_i16_into<T>(&mut self, dst: &mut [i16]) -> Result<(), Error> where
T: ByteOrder,

fn read_i32_into<T>(&mut self, dst: &mut [i32]) -> Result<(), Error> where
T: ByteOrder,

fn read_i64_into<T>(&mut self, dst: &mut [i64]) -> Result<(), Error> where
T: ByteOrder,

fn read_i128_into<T>(&mut self, dst: &mut [i128]) -> Result<(), Error> where
T: ByteOrder,

fn read_f32_into<T>(&mut self, dst: &mut [f32]) -> Result<(), Error> where
T: ByteOrder,

fn read_f32_into_unchecked<T>(&mut self, dst: &mut [f32]) -> Result<(), Error> where
T: ByteOrder,

fn read_f64_into<T>(&mut self, dst: &mut [f64]) -> Result<(), Error> where
T: ByteOrder,

fn read_f64_into_unchecked<T>(&mut self, dst: &mut [f64]) -> Result<(), Error> where
T: ByteOrder,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,