Bz2 Swift Reference Documentation

CkoBz2

Current Version: 11.1.0

Requires Chilkat Bundle License

Provides the ability to create and unzip .bz2 compressed files using the BZip2 compression algorithm.

Object Creation

let obj = CkoBz2()!

Properties

AbortCurrent

abortCurrent: Bool

Introduced in version 9.5.0.58

When set to true, causes the currently running method to abort. Methods that always finish quickly (i.e.have no length file operations or network communications) are not affected. If no method is running, then this property is automatically reset to false when the next method is called. When the abort occurs, this property is reset to false. Both synchronous and asynchronous method calls can be aborted. (A synchronous method call could be aborted by setting this property from a separate thread.)

DebugLogFilePath

debugLogFilePath: String!

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.

More Information and Examples

Example showing how to use DebugLogFilePath.

HeartbeatMs

heartbeatMs: Int

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.

More Information and Examples

Event Callback Examples

LastErrorHtml

lastErrorHtml: String! (read-only)

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.

LastErrorText

lastErrorText: String! (read-only)

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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

lastErrorXml: String! (read-only)

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.

LastMethodSuccess

lastMethodSuccess: Bool

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.

VerboseLogging

verboseLogging: Bool

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

version: String! (read-only)

Version of the component/library, such as "10.1.0"

More Information and Examples

How to get the Chilkat version at runtime.

Methods

CompressBd

compressBd(bd: CkoBinData) -> Bool

Introduced in version 11.0.0

BZ2 compress the contents of bd. After compression, the bd contains the binary content of a .bz2 file, which is slightly different than simple BZIP2 compressed data because a .bz2 file contains:

Header
Compressed blocks
End-of-stream trailer

Returns true for success, false for failure.

CompressBdAsync ⁽¹⁾

compressBdAsync(bd: CkoBinData) -> CkoTask

Introduced in version 11.0.0

Creates an asynchronous task to call the CompressBd 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

CompressFile

compressFile(inPath: String, toPath: String) -> Bool

Compresses a file to create a BZip2 compressed file (.bz2).

Note: Both inFilename and toPath should be relative or absolute file paths (not just a path to a directory). For example someDir1/someDir2/myFile.txt or c:/someDir1/myFile.bz2.

Returns true for success, false for failure.

More Information and Examples

bz2 Compress File

CompressFileAsync ⁽¹⁾

compressFileAsync(inPath: String, toPath: String) -> CkoTask

Creates an asynchronous task to call the CompressFile 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

CompressFileToMem

compressFile(toMem: String) -> NSData

BZip2 compresses a file to an in-memory image of a .bz2 file.

Returns nil on failure

CompressFileToMemAsync ⁽¹⁾

compressFile(toMemAsync: String) -> CkoTask

Creates an asynchronous task to call the CompressFileToMem 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

CompressMemory

compressMemory(inData: NSData) -> NSData

Compresses in-memory data to an in-memory image of a .bz2 file.

Returns nil on failure

CompressMemoryAsync ⁽¹⁾

compressMemoryAsync(inData: NSData) -> CkoTask

Creates an asynchronous task to call the CompressMemory 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

CompressMemToFile

compressMem(toFile: NSData, toPath: String) -> Bool

BZip2 compresses and creates a .bz2 file from in-memory data.

Returns true for success, false for failure.

CompressMemToFileAsync ⁽¹⁾

compressMem(toFileAsync: NSData, toPath: String) -> CkoTask

Creates an asynchronous task to call the CompressMemToFile 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

loadTaskCaller(task: CkoTask) -> Bool

Introduced in version 9.5.0.80

Loads the caller of the task's async method.

Returns true for success, false for failure.

UncompressBd

uncompressBd(bd: CkoBinData) -> Bool

Introduced in version 11.0.0

BZ2 uncompress the contents of bd, which initially should contain the bytes of a .bz2 file. After uncompressing, the bd contains the original uncompressed content.

Returns true for success, false for failure.

UncompressBdAsync ⁽¹⁾

uncompressBdAsync(bd: CkoBinData) -> CkoTask

Introduced in version 11.0.0

Creates an asynchronous task to call the UncompressBd 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

UncompressFile

uncompressFile(inPath: String, toPath: String) -> Bool

Unzips a .bz2 file.

Returns true for success, false for failure.

UncompressFileAsync ⁽¹⁾

uncompressFileAsync(inPath: String, toPath: String) -> CkoTask

Creates an asynchronous task to call the UncompressFile 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

UncompressFileToMem

uncompressFile(toMem: String) -> NSData

Unzips a .bz2 file directly to memory.

Returns nil on failure

UncompressFileToMemAsync ⁽¹⁾

uncompressFile(toMemAsync: String) -> CkoTask

Creates an asynchronous task to call the UncompressFileToMem 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

UncompressMemory

uncompressMemory(inData: NSData) -> NSData

Unzips from an in-memory image of a .bz2 file directly into memory.

Returns nil on failure

UncompressMemoryAsync ⁽¹⁾

uncompressMemoryAsync(inData: NSData) -> CkoTask

Creates an asynchronous task to call the UncompressMemory 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

UncompressMemToFile

uncompressMem(toFile: NSData, toPath: String) -> Bool

Unzips from an in-memory image of a .bz2 file to a file.

Returns true for success, false for failure.

UncompressMemToFileAsync ⁽¹⁾

uncompressMem(toFileAsync: NSData, toPath: String) -> CkoTask

Creates an asynchronous task to call the UncompressMemToFile 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 MyBz2Progress : 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 bz = CkoBz2()
    let myBzProgress = MyBz2Progress()
    
    bz.setEventCallbackObject(myBzProgress)

    // ...
    // ...
    // ...
}

AbortCheck

abortCheck(abort: Bool)

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.

More Information and Examples

Chilkat Event Callback Examples

PercentDone

percentDone(pctDone: Int, abort: Bool)

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.

More Information and Examples

Chilkat Event Callback Examples

ProgressInfo

progressInfo(name: String, value: String)

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.

More Information and Examples

Chilkat Event Callback Examples

TaskCompleted

taskCompleted(task: CkoTask)

Called from the background thread when an asynchronous task completes.

top