Bz2 Swift Reference Documentation

CkoBz2

Current Version: 10.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

This is the number of milliseconds between each AbortCheck event callback. The AbortCheck callback allows an application to abort any compress or decompress operation prior to completion. If HeartbeatMs is 0, no AbortCheck event callbacks will occur.

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

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.

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)

Provides the opportunity for a method call to be aborted. The AbortCheck event is fired periodically based on the value of the HeartbeatMs property. If HeartbeatMs is 0, then no AbortCheck events will fire. As an example, to fire 5 AbortCheck events per second, set the HeartbeatMs property equal to 200.

PercentDone

percentDone(pctDone: Int, abort: Bool)

Provides the percentage completed for any method that involves network communications or time-consuming processing (assuming it is a method where a percentage completion can be measured). This event is only fired when it is possible to know a percentage completion, and when it makes sense to express the operation as a percentage completed. The pctDone argument will have a value from 1 to 100. For operations (Chilkat method calls) that complete very quickly, the number of PercentDone callbacks will vary, but the final callback should have a value of 100. For long running operations, no more than one callback per percentage point will occur (for example: 1, 2, 3, ... 98, 99, 100).

The PercentDone callback counts as an AbortCheck event. For method calls that complete quickly such that PercentDone events fire, it may be that AbortCheck events don't fire because the opportunity to abort is already provided in the PercentDone callback. For time consuming operations, where the amount of time between PercentDone callbacks are long, AbortCheck callbacks may be used to allow for the operation to be aborted in a more responsive manner.

The abort output argument provides a means for aborting the operation. Setting it to true will cause the method to abort and return a failed status (or whatever return value indicates failure).

ProgressInfo

progressInfo(name: String, value: String)

A general name/value event that provides information about what is happening during a method call. To find out what information is available, write code to handle this event and log the name/value pairs. Most are self-explanatory.

TaskCompleted

taskCompleted(task: CkoTask)

Called in the background thread when an asynchronous task completes.

top