Struct rc_zip_sync::SyncStoredEntry

pub struct SyncStoredEntry<'a, F> { /* private fields */ }

A zip entry, read synchronously from a file or other I/O resource.

Implementations

impl<'a, F> SyncStoredEntry<'a, F>

where F: HasCursor,

pub fn reader(&self) -> impl Read + 'a

Returns a reader for the entry.

pub fn bytes(&self) -> Result<Vec<u8>>

Reads the entire entry into a vector.

Methods from Deref<Target = StoredEntry>

pub fn name(&self) -> &str

Returns the entry’s name. See also sanitized_name(), which returns a sanitized version of the name.

This should be a relative path, separated by /. However, there are zip files in the wild with all sorts of evil variants, so, be conservative in what you accept.

pub fn sanitized_name(&self) -> Option<&str>

Returns a sanitized version of the entry’s name, if it seems safe. In particular, if this method feels like the entry name is trying to do a zip slip (cf. https://snyk.io/research/zip-slip-vulnerability), it’ll return None.

Other than that, it will strip any leading slashes on non-Windows OSes.

pub fn comment(&self) -> Option<&str>

The entry’s comment, if any.

When reading a zip file, an empty comment results in None.

pub fn method(&self) -> Method

The compression method used for this entry

pub fn modified(&self) -> DateTime<Utc>

This entry’s “last modified” timestamp - with caveats

Due to the history of the ZIP file format, this may be inaccurate. It may be offset by a few hours, if there is no extended timestamp information. It may have a resolution as low as two seconds, if only MSDOS timestamps are present. It may default to the Unix epoch, if something went really wrong.

If you’re reading this after the year 2038, or after the year 2108, godspeed.

pub fn created(&self) -> Option<&DateTime<Utc>>

This entry’s “created” timestamp, if available.

See StoredEntry::modified() for caveats.

pub fn accessed(&self) -> Option<&DateTime<Utc>>

This entry’s “last accessed” timestamp, if available.

See StoredEntry::modified() for caveats.

pub fn contents(&self) -> EntryContents

Determine EntryContents of this entry based on its mode.

Trait Implementations

impl<F> Deref for SyncStoredEntry<'_, F>

type Target = StoredEntry

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.