Display the source code in std/zip.d from which this page was generated on github.

If you spot a problem with this page, click here to create a Bugzilla issue.

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.

Class `std.zip.ZipArchive`

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


						
				class ZipArchive
				;

Constructors

Name	Description
`this` ()	Constructor to use when creating a new archive.
`this` (buffer)	Constructor to use when reading an existing archive.

Fields

Name	Type	Description
`comment`	`string`	The archive comment. Must be less than 65536 bytes in length.

Properties

Name	Type	Description
`data`[get]	`ubyte[]`	Array representing the entire contents of the archive.
`directory`[get]	`ArchiveMember[string]`	Associative array indexed by the name of each member of the archive.
`diskNumber`[get]	`uint`	0 since multi-disk zip archives are not supported.
`diskStartDir`[get]	`uint`	0 since multi-disk zip archives are not supported.
`isZip64`[get, set]	`bool`	True when the archive is in Zip64 format. Set this to true to force building a Zip64 archive.
`numEntries`[get]	`uint`	Number of ArchiveMembers in the directory.
`totalEntries`[get]	`uint`	Number of ArchiveMembers in the directory.

Methods

Name	Description
`addMember` (de)	Add a member to the archive. The file is compressed on the fly.
`build` ()	Construct the entire contents of the current members of the archive.
`deleteMember` (de)	Delete member `de` from the archive. Uses the name of the member to detect which element to delete.
`expand` (de)	Decompress the contents of a member.
`factory` (classname)	Create instance of class specified by the fully qualified name classname. The class must either have no constructors or have a default constructor.
`opCmp` (o)	Compare with another Object obj.
`opEquals` (o)	Test whether `this` is equal to `o`. The default implementation only compares by identity (using the `is` operator). Generally, overrides and overloads for `opEquals` should attempt to compare objects by their contents. A class will most likely want to add an overload that takes your specific type as the argument and does the content comparison. Then you can override this and forward it to your specific typed overload with a cast. Remember to check for `null` on the typed overload.
`toHash` ()	Compute hash function for Object.
`toString` ()	Convert Object to a human readable string.

Authors

Walter Bright

License

Boost License 1.0.