ZipEntry Swift Reference Documentation
CkoZipEntry
Current Version: 11.4.0
The Chilkat.ZipEntry class represents a single entry
contained within a Chilkat.Zip object.
For a more complete introduction and conceptual overview, see:
A ZipEntry may represent:
- A file already contained within an opened ZIP archive
- A referenced filesystem file that has not yet been compressed
- An in-memory data entry containing text or binary data
- A directory entry
ZipEntry objects provide access to ZIP entry metadata such as:
- Filename and stored ZIP path
- Compressed and uncompressed sizes
- Compression method and compression level
- Encryption information
- Last-modified timestamps
- CRC values and entry attributes
ZipEntry objects can also be used to:
- Extract individual entries
- Inflate entry contents directly into memory
- Replace or append entry data
- Iterate through ZIP archive entries
- Access compressed entry data
A ZipEntry object is typically obtained from a
Chilkat.Zip object using methods such as
EntryAt, EntryOf,
EntryMatching, or FirstEntry.
The EntryType property indicates the current state of
the entry, such as whether it is a mapped entry from an existing ZIP,
a referenced filesystem file awaiting compression, or an in-memory
data entry.
Object Creation
let obj = CkoZipEntry()!
Properties
Comment
Gets or sets the comment stored in the ZIP archive for this entry.
topCompressedLength
The compressed size of this entry, in bytes.
For mapped entries (entries already contained within an opened ZIP archive), this property contains the actual compressed size stored within the ZIP.
For file entries or data entries that have not yet been written to a ZIP archive, compression has not yet occurred. In these cases, this property contains:
- The current uncompressed data size for data entries.
- The cached filesystem file size for referenced file entries.
After the ZIP archive is written, the entries become mapped entries, and this property then reflects the actual compressed size stored in the ZIP archive.
topCompressedLengthStr
The compressed size of this entry as a decimal string.
For mapped entries (entries already contained within an opened ZIP archive), this property contains the actual compressed size stored within the ZIP.
For file entries or data entries that have not yet been written to a ZIP archive, compression has not yet occurred. In these cases, this property contains:
- The current uncompressed data size for data entries.
- The cached filesystem file size for referenced file entries.
After the ZIP archive is written, the entries become mapped entries, and this property then reflects the actual compressed size stored in the ZIP archive.
This property is useful when sizes may exceed the range of a 32-bit integer.
topCompressionLevel
Gets or sets the compression level for this entry.
A value of 0 means no compression, and a value of
9 means maximum compression.
The default value is 6.
CompressionMethod
Gets or sets the compression method used for this entry.
-
0means no compression. -
8means Deflate compression.
Deflate is the standard compression algorithm used by common ZIP utilities such as WinZip.
topCrc
DebugLogFilePath
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
EncryptionKeyLen
The AES encryption key length for this entry.
If this entry is AES encrypted, the value is 128,
192, or 256.
If this entry is not AES encrypted, the value is 0.
EntryID
A unique identifier assigned to this entry while the ZIP object is instantiated in memory.
This ID can be used to retrieve the same entry later with
Zip.EntryById.
EntryType
Indicates the origin and current state of this ZIP entry.
-
0— Mapped Entry: an entry that already exists in an open ZIP file. -
1— File Entry: a file in the local filesystem that has been referenced, but not yet read or compressed. -
2— Data Entry: an entry containing uncompressed data already held in memory. -
3— Null Entry: an entry that no longer exists in the ZIP archive. -
4— New Directory Entry: a directory entry added to the ZIP object.
When the ZIP archive is written by calling WriteZip or
WriteToMemory, entries are transformed into mapped entries.
In other words, after writing, they point to compressed data contained
in the newly created or rewritten ZIP archive.
FileDateTimeStr
Gets or sets the local last-modified date/time for this ZIP entry in RFC 822 string format.
Example RFC 822 date/time strings:
Tue, 15 Nov 1994 12:45:26 GMT
Fri, 05 Jan 2024 18:30:00 -0500
The timezone may be specified either as a named timezone such as
GMT, or as a numeric UTC offset such as
-0500.
FileName
Gets or sets the filename, including any relative path, stored for this entry inside the ZIP archive.
Changing this property changes the path/name that will appear in the ZIP archive. It does not rename a source file in the local filesystem.
FileNameHex
Returns the raw filename bytes found in the ZIP entry, encoded as a hexadecimal string.
This can be useful for diagnosing filename encoding issues.
topHeartbeatMs
The interval in milliseconds between each AbortCheck event callback, which enables an application to abort certain method calls before they complete. By default, HeartbeatMs is set to 0, meaning no AbortCheck event callbacks will trigger.
IsAesEncrypted
Indicates whether this ZIP entry is AES encrypted.
This property can be trueOpenZip, OpenBd, or
OpenFromMemory.
If the entry is not AES encrypted, the property is
false
IsDirectory
Indicates whether this ZIP entry is a directory entry.
The value is truefalse
LastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
TextFlag
Gets or sets the text flag in the internal file attributes for this ZIP entry.
This flag indicates whether the entry contents should be considered text rather than binary data.
The flag is informational and does not need to be accurate for normal ZIP processing. It is provided for compatibility with applications that may be sensitive to this attribute.
topUncompressedLength
The uncompressed size of this entry, in bytes.
topUncompressedLengthStr
The uncompressed size of this ZIP entry as a decimal string.
This is useful when the uncompressed size may be larger than what can safely be represented by a 32-bit integer.
topVerboseLogging
If set to true, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is false. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
Version
Methods
AppendData
Appends binary data to this ZIP entry's file contents.
If this entry is already a Data Entry
(EntryType = 2), then the bytes in
inData are appended directly to the existing
uncompressed in-memory data.
If this entry is not already a Data Entry, then the entry is first converted into a Data Entry before the new data is appended.
-
If the entry is a mapped entry
(
EntryType = 0), the compressed ZIP entry data is first inflated into memory. The new data is then appended, and the entry becomes a Data Entry containing the combined uncompressed data. -
If the entry is a file entry
(
EntryType = 1), the referenced filesystem file is first loaded into memory. The new data is then appended, and the entry becomes a Data Entry containing the combined data.
After this method is called, the entry contents exist entirely as uncompressed in-memory data associated with the ZipEntry object.
Returns true for success, false for failure.
topAppendDataAsync (1)
Creates an asynchronous task to call the AppendData method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
AppendString
Appends text data to this ZIP entry's file contents.
The text is converted to bytes using the character encoding specified
by charset, such as utf-8,
utf-16, or ansi.
If this entry is already a Data Entry
(EntryType = 2), then the encoded bytes are appended
directly to the existing uncompressed in-memory data.
If this entry is not already a Data Entry, then the entry is first converted into a Data Entry before the new text data is appended.
-
If the entry is a mapped entry
(
EntryType = 0), the compressed ZIP entry data is first inflated into memory. The new text data is then appended, and the entry becomes a Data Entry containing the combined uncompressed data. -
If the entry is a file entry
(
EntryType = 1), the referenced filesystem file is first loaded into memory. The new text data is then appended, and the entry becomes a Data Entry containing the combined data.
After this method is called, the entry contents exist entirely as uncompressed in-memory data associated with the ZipEntry object.
Returns true for success, false for failure.
AppendStringAsync (1)
Creates an asynchronous task to call the AppendString method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
Copy
Returns the compressed data for this ZIP entry as a byte array.
This method can only be called when the entry already contains compressed data. In other words, the entry must be a mapped entry.
This is the case when an existing ZIP archive has been opened, or
after a ZIP archive has been written using WriteZip or
WriteToMemory.
If the entry was added using methods such as AppendData,
AppendFiles, or AddFile, it does not yet
contain compressed data. The entry becomes a mapped entry after the
ZIP archive is written.
Returns nil on failure
CopyToBase64
Returns the compressed data for this ZIP entry as a Base64-encoded string.
This method can only be used when the entry already contains compressed data, meaning the entry is a mapped entry.
This is possible for entries from a ZIP archive that has already been opened, or after writing a ZIP archive while it remains open.
Returns nil on failure
CopyToHex
Returns the compressed data for this ZIP entry as a hexadecimal encoded string.
This method can only be used when the entry already contains compressed data, meaning the entry is a mapped entry.
This is possible for entries from a ZIP archive that has already been opened, or after writing a ZIP archive while it remains open.
Returns nil on failure
Extract
Extracts this ZIP entry beneath the specified base directory.
The entry is extracted according to the relative path stored in the ZIP archive.
For example, if the entry filename is
docs/readme.txt and dirPath is
c:/temp/output, the file is extracted to
c:/temp/output/docs/readme.txt.
Use ExtractInto instead if the file should be extracted
directly into a specific directory regardless of the path stored in
the ZIP archive.
Returns true for success, false for failure.
ExtractAsync (1)
Creates an asynchronous task to call the Extract method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
ExtractInto
Extracts this entry directly into the specified directory, ignoring any path information stored in the ZIP entry.
For example, if the entry filename is
docs/readme.txt and dirPath is
c:/temp/output, the file is extracted to
c:/temp/output/readme.txt.
If this entry is a directory entry, nothing is extracted. To create
the directory represented by a directory entry, use
Extract instead.
Returns true for success, false for failure.
topExtractIntoAsync (1)
Creates an asynchronous task to call the ExtractInto method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
GetNext
Updates this ZipEntry object so that it represents the
next entry in the same ZIP archive.
The next entry may be either a file entry or a directory entry.
Returns truefalse
GetNextMatch
Updates this ZipEntry object so that it represents the
next entry in the ZIP archive matching the specified wildcard pattern.
The wildcard character * matches zero or more characters.
Matching is performed against the full stored filename, including any
relative path.
The matching entry may be either a file entry or a directory entry.
Returns truefalse
Inflate
Inflates this ZIP entry directly into memory and returns the uncompressed data as a byte array.
This method is used to obtain the uncompressed bytes of a single ZIP entry without extracting it to a file.
Returns nil on failure
InflateAsync (1)
Creates an asynchronous task to call the Inflate method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
LoadTaskCaller
ReplaceData
Replaces this ZIP entry's existing contents with new binary data.
The new data becomes the complete contents of the entry.
Returns true for success, false for failure.
topReplaceString
Replaces this ZIP entry's existing contents with new text data.
The text is converted to bytes using the character encoding specified
by charset, such as utf-8 or
ansi.
The resulting bytes become the complete contents of the entry.
Returns true for success, false for failure.
SetDt
Sets the last-modified date/time for this ZIP entry.
The dt argument is a CkDateTime object
containing the date/time to store for the entry.
UnzipToBd
Unzips this entry directly into a BinData object.
The uncompressed bytes are written to binData.
Returns true for success, false for failure.
UnzipToBdAsync (1)
Creates an asynchronous task to call the UnzipToBd method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
UnzipToSb
Unzips this entry as text and appends the result to a
StringBuilder.
The srcCharset argument specifies how the uncompressed
bytes should be interpreted, such as utf-8,
utf-16, or windows-1252.
The lineEndingBehavior argument controls line-ending
conversion:
-
0— leave line endings unchanged. -
1— convert all line endings to bare LF. -
2— convert all line endings to CRLF.
Returns true for success, false for failure.
UnzipToSbAsync (1)
Creates an asynchronous task to call the UnzipToSb method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
UnzipToStream
Unzips this entry to a stream.
If called synchronously, the toStream must have a sink,
such as a file or another stream object.
If called asynchronously, the foreground thread can read from the stream while the unzip operation writes to it.
Returns true for success, false for failure.
UnzipToStreamAsync (1)
Creates an asynchronous task to call the UnzipToStream method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
UnzipToString
Inflates this entry and returns the uncompressed data as a string.
The srcCharset argument specifies how the uncompressed
bytes should be interpreted, such as utf-8,
utf-16, or windows-1252.
The lineEndingBehavior argument controls line-ending
conversion:
-
0— leave line endings unchanged. -
1— convert all line endings to bare LF. -
2— convert all line endings to CRLF.
Returns nil on failure
UnzipToStringAsync (1)
Creates an asynchronous task to call the UnzipToString method with the arguments provided.
Note: Async method event callbacks happen in the background thread. Accessing and updating UI elements existing in the main thread may require special considerations.
Returns nil on failure
Events
To implement an event callback, your application would define and implement a class that inherits from CkoBaseProgress. Your application can implement methods to override some or all of the default/empty method implementations of the CkoBaseProgress base class.
For example:
class MyZipEntryProgress : CkoBaseProgress {
override func ProgressInfo(name: String!, value: String!) {
// application code goes here...
print(name + ": " + value)
}
override func AbortCheck(abort: UnsafeMutablePointer) {
// application code goes here...
// To abort the operation, set this equal to true instead of false.
abort.memory = false
}
override func PercentDone(pctDone: NSNumber!, abort: UnsafeMutablePointer) {
// application code goes here...
print(pctDone)
// To abort the operation, set this equal to true instead of false.
abort.memory = false
}
// For asynchronous method calls.
override func TaskCompleted(task: CkoTask!) {
// application code goes here...
}
}
func someAppFunction() {
// Demonstrate how to set the event callback object...
let zipentry = CkoZipEntry()
let myZipEntryProgress = MyZipEntryProgress()
zipentry.setEventCallbackObject(myZipEntryProgress)
// ...
// ...
// ...
}
AbortCheck
Enables a method call to be aborted by triggering the AbortCheck event at intervals defined by the HeartbeatMs property. If HeartbeatMs is set to its default value of 0, no events will occur. For instance, set HeartbeatMs to 200 to trigger 5 AbortCheck events per second.
PercentDone
This provides the percentage completion for any method involving network communications or time-consuming processing, assuming the progress can be measured as a percentage. This event is triggered only when it's possible and logical to express the operation's progress as a percentage. The pctDone argument will range from 1 to 100. For methods that finish quickly, the number of PercentDone callbacks may vary, but the final callback will have pctDone equal to 100. For longer operations, callbacks will not exceed one per percentage point (e.g., 1, 2, 3, ..., 98, 99, 100).
The PercentDone callback also acts as an AbortCheck event. For fast methods where PercentDone fires, an AbortCheck event may not trigger since the PercentDone callback already provides an opportunity to abort. For longer operations, where time between PercentDone callbacks is extended, AbortCheck callbacks enable more responsive operation termination.
To abort the operation, set the abort output argument to true. This will cause the method to terminate and return a failure status or corresponding failure value.
ProgressInfo
This event callback provides tag name/value pairs that detail what occurs during a method call. To discover existing tag names, create code to handle the event, emit the pairs, and review them. Most tag names are self-explanatory.
TaskCompleted
Called from the background thread when an asynchronous task completes.
Deprecated
GetDt
This method is deprecated and will be removed in a future version. Use the FileDateTimeStr property instead.
Returns the last-modified date/time of this zip entry.
Returns nil on failure
NextEntry
This method is deprecated. Applications should instead call GetNext.
Return the next entry (file or directory) within the Zip
Returns nil on failure
NextMatchingEntry
This method is deprecated. Applications should instead call GetNextMatch.
Returns the next entry having a filename matching a pattern. The * characters matches 0 or more of any character. The full filename, including path, is used when matching against the pattern. A NULL is returned if nothing matches.
Returns nil on failure