Crate rc_zip

rc-zip

rc-zip is a zip archive library with a focus on compatibility and correctness.

Reading

ArchiveReader is your first stop. It ensures we are dealing with a valid zip archive, and reads the central directory. It does not perform I/O itself, but rather, it is a state machine that asks for reads at specific offsets.

An Archive contains a full list of entries, which you can then extract.

Writing

Writing archives is not implemented yet.

Modules

• prelude
  Prelude for rc-zip
• reader

Macros

• fields
• transition

Structs

• Archive
  An Archive contains general information about a zip files, along with a list of entries.
• DataDescriptorRecord
  4.3.9 Data descriptor:
• DirectoryHeader
  4.3.12 Central directory structure: File header
• EndOfCentralDirectory
  Coalesces zip and zip64 “end of central directory” record info
• EndOfCentralDirectory64Locator
  4.3.15 Zip64 end of central directory locator
• EndOfCentralDirectory64Record
  4.3.14 Zip64 end of central directory record
• EndOfCentralDirectoryRecord
  4.3.16 End of central directory record:
• Entry
  Describes a zip archive entry (a file, a directory, a symlink)
• ExtraNewUnixField
  Info-ZIP New Unix Extra Field:
• ExtraNtfsField
  4.5.5 -NTFS Extra Field (0x000a):
• ExtraTimestampField
  Extended timestamp extra field
• ExtraUnixField
  4.5.7 -UNIX Extra Field (0x000d):
• ExtraZip64Field
  4.5.3 -Zip64 Extended Information Extra Field (0x0001)
• LocalFileHeaderRecord
  4.3.7 Local file header
• Located
• Mode
  Mode represents a file’s mode and permission bits. The bits have the same definition on all systems, but not all bits apply to all systems.
• MsdosMode
• MsdosTimestamp
  A timestamp in MS-DOS format
• NtfsAttr1
• NtfsTimestamp
  A timestamp in NTFS format.
• StoredEntry
  An entry as stored into an Archive. Contains additional metadata and offset information.
• UnixMode
• Version
  A zip version (either created by, or required when reading an archive).
• ZipBytes
  A raw u8 slice, with no specific structure.
• ZipString
  A raw zip string, with no specific encoding.

Enums

• Encoding
  Encodings supported by this crate
• EntryContents
  The contents of an entry: a directory, a file, or a symbolic link.
• Error
  Any zip-related error, from invalid archives to encoding problems.
• ExtraField
  Information stored in the central directory header extra field
• FormatError
  Specific zip format errors, mostly due to invalid zip archives but that could also stem from implementation shortcomings.
• HostSystem
  System on which an archive was created, as encoded into a version u16.
• Method
  Compression method used for a file entry.
• NtfsAttr
  NTFS attribute for zip entries (mostly timestamps)
• UnsupportedError