Struct secureblackbox::ArchiveWriter

Properties   Methods   Events   Config Settings   Errors  

The ArchiveWriter struct allows compressing, updating and modifying files for zip, tar, gzip and bzip2 archives.

Syntax

secureblackbox::ArchiveWriter

Remarks

Use ArchiveWriter to compress, update, and modify files in archives. ArchiveWriter archiveWriter = new ArchiveWriter(); archiveWriter.setEncryptionType(ArchiveWriter.aetGeneric); // the type of encryption to apply to the archive archiveWriter.setEncryptionPassword("MyPassword"); // specifies the archive encryption password // creates a new archive with the desired archive type as a parameter archiveWriter.createNew(ArchiveWriter.aftZip); // add a file to the archive, the first parameter specifies the path where the file will be saved within the // archive, the second parameter the file that you want to add to the archive archiveWriter.addFile("","C:\\Photos\\MyPhoto.jpeg"); // add a collection of files to the archive, first param specifies the desired mount point for the files within the archive, // second param is the path to the files on the local system, and the last one indicates whether you want to process the // subdirectories recursively archiveWriter.addFiles("","C:\\Photos",true); archiveWriter.save("C:\\MyArchives");

The following common archive formats are supported:

• ZIP (.zip)
• GZip (.gz)
• BZip2 (.bz2)
• Tar+GZip (.tar.gz)
• Tar+Bzip2 (.tar.bz2)

Working with ArchiveWriter

Work with ArchiveWriter builds on the following steps:

Creating or opening the archive.

Use create_new to create a new archive, or one of the Open* methods (such as open or open_bytes) to open an existing compressed file.

Inspecting the archive contents

Use the files collection to access information about individual files stored in the opened archive. On this stage you can adjust the individual files objects' > and > properties to configure bespoke processing for specific files.

Adding files to the archive

ArchiveWriter offers the following methods that you can use to add elements to the archive:

• add_file - adds an entry with the contents of a local file.
• add_files - adds a set of files from a local directory.
• add_virtual - allocates an entry in the archive. The actual data can be provided later using on_prepare_file and on_before_compress_file events.

You can combine different entry types when building your archive.

Updating files in the archive

You can update files already present in the archive (e.g. with newer copies) using update_file and update_files methods. The remove method lets you delete individual files from the archive.

Use decryption_password property to specify a decryption password for an archive and/or a specific entry within it. If the password is required but wasn't set, or if the provided password is wrong, the component will fire the on_decryption_password_needed event. This event is fired repeatedly until the correct password is provided or its Cancel parameter is returned as true.

Saving and closing the archive

Once you are finished with composing/editing the archive, call the component's save (or save_bytes) method to save the updated archive, and then close to close the archive file and release the associated memory.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by SecureBlackbox. Due to this, the ArchiveWriter struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of ArchiveWriter when you have finished using the instance.

Property List

---

The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the struct with short descriptions. Click on the links for further details.

archive_type property (ArchiveWriter Struct)

The type of the archive.

Syntax

fn archive_type(&self ) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Unknown
1   // Zip
2   // Gzip
3   // Bzip2
4   // Tar
5   // TarGzip
6   // TarBzip2
7   // SFX

Default Value

0

Remarks

This property indicates the type of the opened archive.

This property is read-only.

Data Type

i32

compression_algorithm property (ArchiveWriter Struct)

Specifies the compression algorithm to use when forming the ZIP archive.

Syntax

fn compression_algorithm(&self ) -> Result<i32, SecureBlackboxError> 
fn set_compression_algorithm(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

8

Remarks

Use this property to select the compression algorithm to be used when creating a ZIP archive.

A typical choice is DEFLATE, which is the default setting. Some implementations also use STORED as an alternative where no compression is required (so the resulting archive is effectively an uncompressed directory of files).

Data Type

i32

compression_level property (ArchiveWriter Struct)

The compression level to apply to the archived data.

Syntax

fn compression_level(&self ) -> Result<i32, SecureBlackboxError> 
fn set_compression_level(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

6

Remarks

Use this property to specify the compression level (1 to 9) to apply to the archived data.

Data Type

i32

decryption_cert_count property (ArchiveWriter Struct)

The number of records in the DecryptionCert arrays.

Syntax

fn decryption_cert_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_decryption_cert_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• decryption_cert_bytes
• decryption_cert_handle

The array indices start at 0 and end at decryption_cert_count - 1.

Data Type

i32

decryption_cert_bytes property (ArchiveWriter Struct)

Returns the raw certificate data in DER format.

Syntax

fn decryption_cert_bytes(&self , DecryptionCertIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The DecryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptionCertCount property.

This property is read-only.

Data Type

Vec

decryption_cert_handle property (ArchiveWriter Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn decryption_cert_handle(&self , DecryptionCertIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_decryption_cert_handle(&self, DecryptionCertIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The DecryptionCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the DecryptionCertCount property.

Data Type

i64

decryption_password property (ArchiveWriter Struct)

The decryption password.

Syntax

fn decryption_password(&self ) -> Result<String, SecureBlackboxError> 
fn set_decryption_password(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_decryption_password_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to provide the decryption password. You can assign it explicitly before commencing file extraction, or provide it on the fly from on_decryption_password_needed event handler.

Data Type

String

encryption_algorithm property (ArchiveWriter Struct)

Specifies the encryption algorithm to apply to the archive.

Syntax

fn encryption_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_encryption_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_encryption_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to specify the encryption algorithm to apply to the archive.

Struct supports the following algorithms: AES128, AES192, AES256, BLOWFISH, TWOFISH, 3DES, 3DES112, DES, RC2, RC4. Note that not all of them may be supported by the processing software.

Data Type

String

encryption_cert_bytes property (ArchiveWriter Struct)

Returns the raw certificate data in DER format.

Syntax

fn encryption_cert_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.

This property is read-only.

Data Type

Vec

encryption_cert_handle property (ArchiveWriter Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn encryption_cert_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_encryption_cert_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptionCertCount property.

Data Type

i64

encryption_key_length property (ArchiveWriter Struct)

The length of the encryption key.

Syntax

fn encryption_key_length(&self ) -> Result<i32, SecureBlackboxError> 
fn set_encryption_key_length(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Use this setting to specify the length of the encryption key in bits. Keep the key length at zero to let the component use the default value assumed by the encryption algorithm.

Data Type

i32

encryption_password property (ArchiveWriter Struct)

Specifies the archive encryption password.

Syntax

fn encryption_password(&self ) -> Result<String, SecureBlackboxError> 
fn set_encryption_password(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_encryption_password_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Use this property to provide the password to encrypt the archive with. Use it alongside encryption_type and encryption_algorithm properties to set up the whole set of protection settings for the archive.

Data Type

String

encryption_type property (ArchiveWriter Struct)

The type of encryption to apply to the archive.

Syntax

fn encryption_type(&self ) -> Result<i32, SecureBlackboxError> 
fn set_encryption_type(&self, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Default
1   // NoEncryption
2   // Generic
3   // WinZip
4   // Strong

Default Value

0

Remarks

Specifies the encryption type for the archive.

Data Type

i32

file_data property (ArchiveWriter Struct)

The contents of the file being added to the archive.

Syntax

fn file_data(&self ) -> Result<Vec<u8>, SecureBlackboxError> 
fn set_file_data(&self, value : Vec<u8>) ->  Option<SecureBlackboxError> 
fn set_file_data_ref(&self, value : &[u8]) ->  Option<SecureBlackboxError> 

Remarks

Assign this property with a byte array containing the contents of the file being added, if you set the corresponding entry's DataSource to fdsBuffer.

Use file_stream property, with DataSource set to fdsStream, to provide the data in a stream instead. Alternatively, use fdsFile data source to supply the file data in a disk file.

Data Type

Vec

file_count property (ArchiveWriter Struct)

The number of records in the File arrays.

Syntax

fn file_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_file_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• file_action
• file_attributes
• file_compressed_size
• file_data_source
• file_directory
• file_encryption_algorithm
• file_encryption_key_length
• file_encryption_type
• file_folder
• file_local_path
• file_m_time
• file_name
• file_new_file
• file_path
• file_signature_count
• file_signed
• file_size

The array indices start at 0 and end at file_count - 1.

Data Type

i32

file_action property (ArchiveWriter Struct)

This property contains the action to apply to the file.

Syntax

fn file_action(&self , FileIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_file_action(&self, FileIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // Add
1   // Keep
2   // Update
3   // Delete
4   // Extract
5   // Skip

Default Value

0

Remarks

This property contains the action to apply to the file.

Use this property to control the action that should be applied to the file during the compression or extraction. The following actions are supported:

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

Data Type

i32

file_attributes property (ArchiveWriter Struct)

This property provides access to file attributes.

Syntax

fn file_attributes(&self , FileIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_file_attributes(&self, FileIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_file_attributes_ref(&self, FileIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

This property provides access to file attributes.

ZIP archives support the provision of Windows (or DOS, as it is called historically) or Unix file attributes. Use this property to provide access to the attributes or to read them out of an existing archive.

Use "dos:" or "unix:" prefixes to indicate what kind of attributes you need to include, as follows:

Writer.Files[0].Attributes = "unix:-rwxr-xr-x"; Writer.Files[1].Attributes = "unix:-r--r--r--"; Writer.Files[2].Attributes = "dos:readonly"; Writer.Files[3].Attributes = "dos:readonly;hidden"; // supported values: readonly, hidden, system, volumeLabel, directory, archive

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

Data Type

String

file_compressed_size property (ArchiveWriter Struct)

This property contains the size of the file after compression.

Syntax

fn file_compressed_size(&self , FileIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

This property contains the size of the file after compression.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

i64

file_data_source property (ArchiveWriter Struct)

This property contains the type of data source for this entry.

Syntax

fn file_data_source(&self , FileIndex : i32) -> Result<i32, SecureBlackboxError> 
fn set_file_data_source(&self, FileIndex : i32, value : i32) ->  Option<SecureBlackboxError> 

Possible Values

0   // File
1   // Stream
2   // Buffer

Default Value

0

Remarks

This property contains the type of data source for this entry.

Use this property to control the data source for this entry.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

Data Type

i32

file_directory property (ArchiveWriter Struct)

This property tells if the entry is a directory or a regular file.

Syntax

fn file_directory(&self , FileIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

This property tells if the entry is a directory or a regular file.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

bool

file_encryption_algorithm property (ArchiveWriter Struct)

This property returns the symmetric algorithm that was used to encrypt the file.

Syntax

fn file_encryption_algorithm(&self , FileIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

This property returns the symmetric algorithm that was used to encrypt the file.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

String

file_encryption_key_length property (ArchiveWriter Struct)

This property returns the length, in bits, of the encryption key.

Syntax

fn file_encryption_key_length(&self , FileIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property returns the length, in bits, of the encryption key.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

i32

file_encryption_type property (ArchiveWriter Struct)

This property contains the type of encryption applied to the file.

Syntax

fn file_encryption_type(&self , FileIndex : i32) -> Result<i32, SecureBlackboxError> 

Possible Values

0   // Default
1   // NoEncryption
2   // Generic
3   // WinZip
4   // Strong

Default Value

0

Remarks

This property contains the type of encryption applied to the file.

Use this property to find out what kind of encryption was applied to the file.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

i32

file_name property (ArchiveWriter Struct)

This property specifies the original name of the compressed file or folder.

Syntax

fn file_name(&self , FileIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_file_name(&self, FileIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_file_name_ref(&self, FileIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

This property specifies the original name of the compressed file or folder.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

Data Type

String

file_folder property (ArchiveWriter Struct)

This property includes the containing folder of the entry.

Syntax

fn file_folder(&self , FileIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

This property includes the containing folder of the entry.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

String

file_local_path property (ArchiveWriter Struct)

This property contains the local path associated with this entry.

Syntax

fn file_local_path(&self , FileIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_file_local_path(&self, FileIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_file_local_path_ref(&self, FileIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

This property contains the local path associated with this entry.

It typically specifies the source path that the data should be taken from, or the destination it should be extracted to.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

Data Type

String

file_m_time property (ArchiveWriter Struct)

This property contains the entry's last modification time.

Syntax

fn file_m_time(&self , FileIndex : i32) -> Result<String, SecureBlackboxError> 
fn set_file_m_time(&self, FileIndex : i32, value : &str) ->  Option<SecureBlackboxError> 
fn set_file_m_time_ref(&self, FileIndex : i32, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

This property contains the entry's last modification time.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

Data Type

String

file_new_file property (ArchiveWriter Struct)

This property indicates whether the entry corresponds to a file to be added to the archive.

Syntax

fn file_new_file(&self , FileIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

This property indicates whether the entry corresponds to a file to be added to the archive.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

bool

file_path property (ArchiveWriter Struct)

This property contains the full internal path of the archived entry.

Syntax

fn file_path(&self , FileIndex : i32) -> Result<String, SecureBlackboxError> 

Default Value

""

Remarks

This property contains the full internal path of the archived entry.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

String

file_signature_count property (ArchiveWriter Struct)

This property includes the number of signatures covering the entry.

Syntax

fn file_signature_count(&self , FileIndex : i32) -> Result<i32, SecureBlackboxError> 

Default Value

0

Remarks

This property includes the number of signatures covering the entry.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

i32

file_signed property (ArchiveWriter Struct)

This property indicates whether the entry is signed.

Syntax

fn file_signed(&self , FileIndex : i32) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

This property indicates whether the entry is signed.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

bool

file_size property (ArchiveWriter Struct)

This property specifies the size of the file before compression.

Syntax

fn file_size(&self , FileIndex : i32) -> Result<i64, SecureBlackboxError> 

Default Value

0

Remarks

This property specifies the size of the file before compression.

The FileIndex parameter specifies the index of the item in the array. The size of the array is controlled by the FileCount property.

This property is read-only.

Data Type

i64

fips_mode property (ArchiveWriter Struct)

Reserved.

Syntax

fn fips_mode(&self ) -> Result<bool, SecureBlackboxError> 
fn set_fips_mode(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

This property is reserved for future use.

Data Type

bool

hash_algorithm property (ArchiveWriter Struct)

Specifies the hash algorithm to be used to generate the signature.

Syntax

fn hash_algorithm(&self ) -> Result<String, SecureBlackboxError> 
fn set_hash_algorithm(&self, value : &str) ->  Option<SecureBlackboxError> 
fn set_hash_algorithm_ref(&self, value : &String) ->  Option<SecureBlackboxError> 

Default Value

""

Remarks

Set this property before signing the archive to specify the hash algorithm to be used to calculate the signature.

Data Type

String

new_archive property (ArchiveWriter Struct)

Indicates whether the archive object represents a new (rather than opened) archive.

Syntax

fn new_archive(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

This property is set to true if the archive is new, or to false if the struct control is editing an existing archive.

new_archive would typically be set to true after a create_new call, and to false after an open call.

This property is read-only.

Data Type

bool

opened property (ArchiveWriter Struct)

Indicates whether struct is currently in edit mode.

Syntax

fn opened(&self ) -> Result<bool, SecureBlackboxError> 

Default Value

false

Remarks

This property is set to true if the archive control is in edit mode, meaning it was opened with open or created with create_new call.

When an archive is opened, you can add new files to it, remove existing files, or modify encryption attributes.

This property is read-only.

Data Type

bool

overwrite property (ArchiveWriter Struct)

Whether the struct should overwrite existing files.

Syntax

fn overwrite(&self ) -> Result<bool, SecureBlackboxError> 
fn set_overwrite(&self, value : bool) ->  Option<SecureBlackboxError> 

Default Value

false

Remarks

Enable this property to force overwriting of existing files.

Data Type

bool

signing_cert_bytes property (ArchiveWriter Struct)

Returns the raw certificate data in DER format.

Syntax

fn signing_cert_bytes(&self ) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

This property is read-only.

Data Type

Vec

signing_cert_handle property (ArchiveWriter Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn signing_cert_handle(&self ) -> Result<i64, SecureBlackboxError> 
fn set_signing_cert_handle(&self, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

Data Type

i64

signing_chain_count property (ArchiveWriter Struct)

The number of records in the SigningChain arrays.

Syntax

fn signing_chain_count(&self ) -> Result<i32, SecureBlackboxError> 
fn set_signing_chain_count(&self, value : i32) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

This property controls the size of the following arrays:

• signing_chain_bytes
• signing_chain_handle

The array indices start at 0 and end at signing_chain_count - 1.

Data Type

i32

signing_chain_bytes property (ArchiveWriter Struct)

Returns the raw certificate data in DER format.

Syntax

fn signing_chain_bytes(&self , SigningChainIndex : i32) -> Result<Vec<u8>, SecureBlackboxError> 

Remarks

Returns the raw certificate data in DER format.

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

This property is read-only.

Data Type

Vec

signing_chain_handle property (ArchiveWriter Struct)

Allows to get or set a 'handle', a unique identifier of the underlying property object.

Syntax

fn signing_chain_handle(&self , SigningChainIndex : i32) -> Result<i64, SecureBlackboxError> 
fn set_signing_chain_handle(&self, SigningChainIndex : i32, value : i64) ->  Option<SecureBlackboxError> 

Default Value

0

Remarks

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

The SigningChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SigningChainCount property.

Data Type

i64

add_empty_dir method (ArchiveWriter Struct)

Adds an empty folder to the archive.

Syntax

fn add_empty_dir(&self, path : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to added an empty folder to the archive with an internal path of Path.

The method returns the index of the new folder entry in the files collection.

add_file method (ArchiveWriter Struct)

Adds a file to the archive.

Syntax

fn add_file(&self, path : &str, local_path : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to add a disk file to the archive. Provide the local path to the file (e.g. C:\Photos\photo.jpg) via the LocalPath parameter, and the desired path within the archive (e.g. PhotosBackup2020/photo.jpg) via the Path parameter.

add_files method (ArchiveWriter Struct)

Adds a group of files to the archive.

Syntax

fn add_files(&self, folder : &str, local_path : &str, recursive : bool) -> Result<(), SecureBlackboxError>

Remarks

Use this method to add a collection of files to the archive.

Provide the path to the files on a local system (e.g. C:\photos) via the LocalPath parameter, and set Recursive to indicate whether you want to process the subdirectories recursively. Pass the desired mount point for the files within the archive (e.g. Backup2020/photos) via the Folder parameter.

You can use file mask wildcards in LocalPath to only select the files that match the mask.

add_virtual method (ArchiveWriter Struct)

Adds a file placeholder to the archive.

Syntax

fn add_virtual(&self, path : &str) ->  Result<i32, SecureBlackboxError>

Remarks

Use this method to add a placeholder for the entry the contents of which is to be provided on the fly from a stream or buffer.

Pass the path to the entry within the archive (e.g. Reports/report2020.csv) via the Path parameter. After the entry has been added, use on_prepare_file event or files property to tune up the type of the data source (file, stream, or memory buffer). During the actual compression, provide the contents of the entry in a stream or buffer in the on_before_compress_file event handler.

This method returns the index of the new entry in the files collection.

close method (ArchiveWriter Struct)

Closes the archive.

Syntax

fn close(&self) -> Result<(), SecureBlackboxError>

Remarks

Use this method to close the current archive and dispose of all the allocated resources.

Call this method when you are done with the archive.

config method (ArchiveWriter Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, SecureBlackboxError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

create_new method (ArchiveWriter Struct)

Creates a new archive.

Syntax

fn create_new(&self, archive_type : i32) -> Result<(), SecureBlackboxError>

Remarks

Use this method to create a new archive file. Provide the desired archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with save or save_stream method.

do_action method (ArchiveWriter Struct)

Performs an additional action.

Syntax

fn do_action(&self, action_id : &str, action_params : &str) ->  Result<String, SecureBlackboxError>

Remarks

do_action is a generic method available in every struct. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Common ActionIDs:

open method (ArchiveWriter Struct)

Opens an archive file.

Syntax

fn open(&self, archive_type : i32, archive_name : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to open an existing archive file for modification.

Provide the path to the archive file via the ArchiveName parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with save or save_stream method.

open_bytes method (ArchiveWriter Struct)

Loads an archive file from a byte array.

Syntax

fn open_bytes(&self, archive_type : i32, archive_bytes : &[u8]) -> Result<(), SecureBlackboxError>

Remarks

Use this method to load an existing archive file from a byte array.

Provide the archive stream via the ArchiveBytes parameter, and pass the archive type in the ArchiveType parameter.

The following archive types are currently supported:

The archive will be kept in memory until written down with save, save_stream, or save_bytes method.

remove method (ArchiveWriter Struct)

Removes file(s) and/or folder(s) from the archive.

Syntax

fn remove(&self, path : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to remove entries from the archive. Provide an archive-local path via the Path parameter.

Path supports file masks, which makes this method quite powerful (and potentially dangerous).

reset method (ArchiveWriter Struct)

Resets the struct settings.

Syntax

fn reset(&self) -> Result<(), SecureBlackboxError>

Remarks

reset is a generic method available in every struct.

save method (ArchiveWriter Struct)

Compresses the archive and saves it to a file.

Syntax

fn save(&self, archive_name : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to finalize all preparations, compress all the entries set up in files collection, and write the created archive to ArchiveName file.

This method carries out a lot of work and fires a number of events during its execution. Before the compression process starts, on_prepare_file event fires repeatedly to provide the summary of what is being included into the archive. A handler of that event is a good place to make last-minute modifications to the data sources, file names, and actions to take upon the files.

Compression of each entry is surrounded with on_before_compress_file and on_after_compress_file "brackets". Subscribe to on_before_compress_file to supply the file contents for entries with Buffer and Stream data sources. on_after_compress_file is a good place to release the content stream allocated in the on_before_compress_file event handler.

on_progress event fires repeatedly to report the progress of the current and whole operations. It also provides an opportunity to abort the compression process.

save_bytes method (ArchiveWriter Struct)

Compresses the archive and saves it to a byte array.

Syntax

fn save_bytes(&self) ->  Result<Vec<u8>, SecureBlackboxError>

Remarks

Use this method to finalize all preparations and compress all entries contained in the files collection. The method returns the byte array containing the serialized archive.

You can fine-tune the compression process by providing compression details on the fly via the events struct fires. See the description of the save method for the details.

update_file method (ArchiveWriter Struct)

Updates an existing compressed entry with a fresher local version.

Syntax

fn update_file(&self, path : &str, local_path : &str) -> Result<(), SecureBlackboxError>

Remarks

Call this method to update the Path entry in the archive with a fresher entry at LocalPath.

update_files method (ArchiveWriter Struct)

Updates a selection of files in the archive.

Syntax

fn update_files(&self, folder : &str, local_path : &str, add_missing_files : bool, remove_missing_files : bool, recursive : bool) -> Result<(), SecureBlackboxError>

Remarks

This method is a powerful way to update a subset of files in the archive in accordance with a specified criteria.

Pass an archive-local name of the folder to update via the Folder parameter, and the system-local version of the same folder via the LocalPath parameter. Set AddMissingFiles and RemoveMissingFiles as needed to force inclusion of files missing from the archive, or removal of files missing locally, accordingly.

The Recursive parameter specifies whether the directory should be browsed recursively.

update_virtual method (ArchiveWriter Struct)

Updates an entry in the archive with on-the-fly content.

Syntax

fn update_virtual(&self, path : &str) -> Result<(), SecureBlackboxError>

Remarks

Use this method to update content of an existing archive entry. Pass the archive-local entry path via the Path parameter. After updating the entry, tune up its DataSource property in accordance with the desired content origin. Subscribe to on_before_compress_file to supply the actual data via file_data or file_stream properties.

on_action_needed event (ArchiveWriter Struct)

Requests a decision from the application in case of a conflict.

Syntax

// ArchiveWriterActionNeededEventArgs carries the ArchiveWriter ActionNeeded event's parameters.
pub struct ArchiveWriterActionNeededEventArgs {
  fn what_for(&self) -> i32
  fn entry_path(&self) -> &String
  fn dest_path(&self) -> &String
  fn description(&self) -> &String
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// ArchiveWriterActionNeededEvent defines the signature of the ArchiveWriter ActionNeeded event's handler function.
pub trait ArchiveWriterActionNeededEvent {
  fn on_action_needed(&self, sender : ArchiveWriter, e : &mut ArchiveWriterActionNeededEventArgs);
}

impl <'a> ArchiveWriter<'a> {
  pub fn on_action_needed(&self) -> &'a dyn ArchiveWriterActionNeededEvent;
  pub fn set_on_action_needed(&mut self, value : &'a dyn ArchiveWriterActionNeededEvent);
  ...
}

Remarks

The component fires this event to request a decision from the application when it encounters a conflict.

The WhatFor parameter can take one of the following values:

You can control the further flow from the event handler by setting the Action parameter to one of the following values:

on_after_compress_file event (ArchiveWriter Struct)

Marks the completion of compression of a file.

Syntax

// ArchiveWriterAfterCompressFileEventArgs carries the ArchiveWriter AfterCompressFile event's parameters.
pub struct ArchiveWriterAfterCompressFileEventArgs {
  fn path(&self) -> &String
  fn file_size(&self) -> i64
  fn data_source(&self) -> i32
}

// ArchiveWriterAfterCompressFileEvent defines the signature of the ArchiveWriter AfterCompressFile event's handler function.
pub trait ArchiveWriterAfterCompressFileEvent {
  fn on_after_compress_file(&self, sender : ArchiveWriter, e : &mut ArchiveWriterAfterCompressFileEventArgs);
}

impl <'a> ArchiveWriter<'a> {
  pub fn on_after_compress_file(&self) -> &'a dyn ArchiveWriterAfterCompressFileEvent;
  pub fn set_on_after_compress_file(&mut self, value : &'a dyn ArchiveWriterAfterCompressFileEvent);
  ...
}

Remarks

Subscribe to this event to get notified about the completion of compression of a file.

The Path parameter specifies the internal path to the entry inside the archive. The FileSize indicates the size of the file before compression, and the DataSource specifies the type of the source media.

on_before_compress_file event (ArchiveWriter Struct)

Marks the start of compression of a file.

Syntax

// ArchiveWriterBeforeCompressFileEventArgs carries the ArchiveWriter BeforeCompressFile event's parameters.
pub struct ArchiveWriterBeforeCompressFileEventArgs {
  fn path(&self) -> &String
  fn file_size(&self) -> i64
  fn data_source(&self) -> i32
}

// ArchiveWriterBeforeCompressFileEvent defines the signature of the ArchiveWriter BeforeCompressFile event's handler function.
pub trait ArchiveWriterBeforeCompressFileEvent {
  fn on_before_compress_file(&self, sender : ArchiveWriter, e : &mut ArchiveWriterBeforeCompressFileEventArgs);
}

impl <'a> ArchiveWriter<'a> {
  pub fn on_before_compress_file(&self) -> &'a dyn ArchiveWriterBeforeCompressFileEvent;
  pub fn set_on_before_compress_file(&mut self, value : &'a dyn ArchiveWriterBeforeCompressFileEvent);
  ...
}

Remarks

Subscribe to this event to be notified about the start of compression of an archive entry. The handler of this event is a good place to prepare the desired data source.

The Path parameter indicates the path to the extracted entry in the archive. The FileSize specifies the size of the file before compression. Use this event handler to adjust the data source if the file is to be loaded from a stream or buffer. The DataSource parameter indicates the type of the data media:

If passing the data from a stream or buffer, use on_after_compress_file to dispose of any objects allocated in this event handler (such as the source stream).

Use on_prepare_file event to adjust the file data source on the fly.

on_decryption_password_needed event (ArchiveWriter Struct)

Fires when the struct needs a password to decrypt the archive.

Syntax

// ArchiveWriterDecryptionPasswordNeededEventArgs carries the ArchiveWriter DecryptionPasswordNeeded event's parameters.
pub struct ArchiveWriterDecryptionPasswordNeededEventArgs {
  fn password_target(&self) -> &String
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// ArchiveWriterDecryptionPasswordNeededEvent defines the signature of the ArchiveWriter DecryptionPasswordNeeded event's handler function.
pub trait ArchiveWriterDecryptionPasswordNeededEvent {
  fn on_decryption_password_needed(&self, sender : ArchiveWriter, e : &mut ArchiveWriterDecryptionPasswordNeededEventArgs);
}

impl <'a> ArchiveWriter<'a> {
  pub fn on_decryption_password_needed(&self) -> &'a dyn ArchiveWriterDecryptionPasswordNeededEvent;
  pub fn set_on_decryption_password_needed(&mut self, value : &'a dyn ArchiveWriterDecryptionPasswordNeededEvent);
  ...
}

Remarks

Struct fires this event to request a decryption password from the application when it comes across an encrypted archive or entry.

Please assign the password to decryption_password property inside the event handler, or set Cancel to true to cancel the operation. The PasswordTarget parameter references the object that is protected with the requested password.

on_error event (ArchiveWriter Struct)

Reports information about errors during archive assembling.

Syntax

// ArchiveWriterErrorEventArgs carries the ArchiveWriter Error event's parameters.
pub struct ArchiveWriterErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// ArchiveWriterErrorEvent defines the signature of the ArchiveWriter Error event's handler function.
pub trait ArchiveWriterErrorEvent {
  fn on_error(&self, sender : ArchiveWriter, e : &mut ArchiveWriterErrorEventArgs);
}

impl <'a> ArchiveWriter<'a> {
  pub fn on_error(&self) -> &'a dyn ArchiveWriterErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn ArchiveWriterErrorEvent);
  ...
}

Remarks

The event is fired in case of exceptional conditions during archive formation.

ErrorCode contains an error code and Description contains a textual description of the error.

on_notification event (ArchiveWriter Struct)

This event notifies the application about an underlying control flow event.

Syntax

// ArchiveWriterNotificationEventArgs carries the ArchiveWriter Notification event's parameters.
pub struct ArchiveWriterNotificationEventArgs {
  fn event_id(&self) -> &String
  fn event_param(&self) -> &String
}

// ArchiveWriterNotificationEvent defines the signature of the ArchiveWriter Notification event's handler function.
pub trait ArchiveWriterNotificationEvent {
  fn on_notification(&self, sender : ArchiveWriter, e : &mut ArchiveWriterNotificationEventArgs);
}

impl <'a> ArchiveWriter<'a> {
  pub fn on_notification(&self) -> &'a dyn ArchiveWriterNotificationEvent;
  pub fn set_on_notification(&mut self, value : &'a dyn ArchiveWriterNotificationEvent);
  ...
}

Remarks

The struct fires this event to let the application know about some event, occurrence, or milestone in the struct. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the struct, the exact action it is performing, or the document being processed, one or both may be omitted.

on_prepare_file event (ArchiveWriter Struct)

Fires for every file to be compressed before the compression starts.

Syntax

// ArchiveWriterPrepareFileEventArgs carries the ArchiveWriter PrepareFile event's parameters.
pub struct ArchiveWriterPrepareFileEventArgs {
  fn path(&self) -> &String
  fn file_size(&self) -> i64
  fn data_source(&self) -> i32
  fn set_data_source(&self, value : i32)
  fn local_path(&self) -> &String
  fn set_local_path(&self, value : &str)
  fn set_local_path_ref(&self, value : &String)
  fn action(&self) -> i32
  fn set_action(&self, value : i32)
}

// ArchiveWriterPrepareFileEvent defines the signature of the ArchiveWriter PrepareFile event's handler function.
pub trait ArchiveWriterPrepareFileEvent {
  fn on_prepare_file(&self, sender : ArchiveWriter, e : &mut ArchiveWriterPrepareFileEventArgs);
}

impl <'a> ArchiveWriter<'a> {
  pub fn on_prepare_file(&self) -> &'a dyn ArchiveWriterPrepareFileEvent;
  pub fn set_on_prepare_file(&mut self, value : &'a dyn ArchiveWriterPrepareFileEvent);
  ...
}

Remarks

Struct fires this event for every file included in the files collection before commencing the compression. This is the last opportunity for your code to adjust the action to be taken for each file and tune up the data sources appropriately.

The Path parameter contains the path to the file within the archive (such as Photos/myphoto.jpg), and the FileSize contains the size of that file before compression.

The DataSource parameter indicates the media from which the file contents is to be taken. A typical default value if fdsFile, but you can adjust the value of that parameter if you need to use an alternative source. The following options are available:

Please do not assign file_stream or file_data in this event handler: this should be done further down the road in the on_before_compress_file event handler. The purpose of this event is to prepare the compression plan by summarizing what should be done and to which files.

The Action parameter, which is also tuneable, indicates the action for struct to take on the file:

on_progress event (ArchiveWriter Struct)

Reports the progress of data compression.

Syntax

// ArchiveWriterProgressEventArgs carries the ArchiveWriter Progress event's parameters.
pub struct ArchiveWriterProgressEventArgs {
  fn processed(&self) -> i64
  fn total(&self) -> i64
  fn overall_processed(&self) -> i64
  fn overall_total(&self) -> i64
  fn cancel(&self) -> bool
  fn set_cancel(&self, value : bool)
}

// ArchiveWriterProgressEvent defines the signature of the ArchiveWriter Progress event's handler function.
pub trait ArchiveWriterProgressEvent {
  fn on_progress(&self, sender : ArchiveWriter, e : &mut ArchiveWriterProgressEventArgs);
}

impl <'a> ArchiveWriter<'a> {
  pub fn on_progress(&self) -> &'a dyn ArchiveWriterProgressEvent;
  pub fn set_on_progress(&mut self, value : &'a dyn ArchiveWriterProgressEvent);
  ...
}

Remarks

Subscribe to this event to be notified about compression progress.

Processed and Total report the progress of compression of the current entry; OverallProcessed and OverallTotal report the progress of the whole operation. Set Cancel to true to stop the operation.

on_recipient_found event (ArchiveWriter Struct)

Signifies that the archive was found to be encrypted with a digital certificate.

Syntax

// ArchiveWriterRecipientFoundEventArgs carries the ArchiveWriter RecipientFound event's parameters.
pub struct ArchiveWriterRecipientFoundEventArgs {
  fn public_key_hash(&self) -> &String
  fn cert_found(&self) -> bool
}

// ArchiveWriterRecipientFoundEvent defines the signature of the ArchiveWriter RecipientFound event's handler function.
pub trait ArchiveWriterRecipientFoundEvent {
  fn on_recipient_found(&self, sender : ArchiveWriter, e : &mut ArchiveWriterRecipientFoundEventArgs);
}

impl <'a> ArchiveWriter<'a> {
  pub fn on_recipient_found(&self) -> &'a dyn ArchiveWriterRecipientFoundEvent;
  pub fn set_on_recipient_found(&mut self, value : &'a dyn ArchiveWriterRecipientFoundEvent);
  ...
}

Remarks

The struct fires this event to notify the application that the archive was found to be encrypted with a digital certificate. The hash of the certificate's public key is provided in the PublicKeyHash parameter.

CertFound indicates whether a certificate with a matching public key hash was found in the decryption_certificates list. If it wasn't, you need to locate it on the system and add it to that list: struct won't be able to decrypt the archive otherwise.

Please note that the certificate must have an associated private key to be capable of decryption.

Config Settings (ArchiveWriter Struct)

The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

ArchiveWriter Config Settings

Base Config Settings

Trappable Errors (ArchiveWriter Struct)