View source code Display the source code in std/zip.d from which this page was generated on github. Improve this page Quickly fork, edit online, and submit a pull request for this page. Requires a signed-in GitHub account. This works well for small changes. If you'd like to make larger changes you may want to consider using local clone. Page wiki View or edit the community-maintained wiki page associated with this page.

Class std.zip.ZipArchive

Object representing the entire archive. ZipArchives are collections of ArchiveMembers.

Inherits from

Constructors

Name Description
this Constructor to use when creating a new archive.
this Constructor to use when reading an existing archive.

Fields

Name Type Description
comment string Read/Write: the archive comment. Must be less than 65536 bytes in length.

Properties

Name Type Description
data [get] ubyte[] Read Only: array representing the entire contents of the archive.
directory [get] ArchiveMember[string] Read Only: array indexed by the name of each member of the archive. All the members of the archive can be accessed with a foreach loop:
diskNumber [get] uint Read Only: 0 since multi-disk zip archives are not supported.
diskStartDir [get] uint Read Only: 0 since multi-disk zip archives are not supported
isZip64 [get] bool True when the archive is in Zip64 format.
isZip64 [set] bool Set this to true to force building a Zip64 archive.
numEntries [get] uint Read Only: number of ArchiveMembers in the directory.
totalEntries [get] uint Read Only: number of ArchiveMembers in the directory.

Methods

Name Description
addMember Add de to the archive.
build Construct an archive out of the current members of the archive.
deleteMember Delete de from the archive.
expand Decompress the contents of archive member de and return the expanded data.
factory Create instance of class specified by the fully qualified name classname. The class must either have no constructors or have a default constructor.
opCmp Compare with another Object obj.
opEquals Returns !=0 if this object does have the same contents as obj.
toHash Compute hash function for Object.
toString Convert Object to a human readable string.

Authors

Walter Bright

License

Boost License 1.0.

Comments