# Struct ipworkszip::SevenZip The SevenZip struct implements a 7zip-compatible compressor and decompressor. ## Syntax ```text ipworkszip::SevenZip ``` ## Remarks To create a new archive, first set the [archive_file](#archive_file-property-sevenzip-struct) property to the name of the archive to be created. Then, specify the files to be compressed either by invoking [include_files](#include_files-method-sevenzip-struct), or by adding a new object to the files collection and setting the values of the [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) and [file_compressed_name](#file_compressed_name-property-sevenzip-struct). fields. Finally, call the [compress](#compress-method-sevenzip-struct) method to create the archive. To decompress an existing archive, set [archive_file](#archive_file-property-sevenzip-struct) to the name of the archive to be decompressed. The [extract_to_path](#extract_to_path-property-sevenzip-struct) property may be set, and then calling the [extract_all](#extract_all-method-sevenzip-struct) method will decompress all files in the archive to this path. For finer control, the [scan](#scan-method-sevenzip-struct) method should be used to read the file information stored in the archive. This will fill out the information in the files collection. The values of [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) may then be changed if desired. Finally, [extract_all](#extract_all-method-sevenzip-struct) may be used to decompress the entire archive, or [extract](#extract-method-sevenzip-struct) may be used for finer control. Data may be streamed out by setting [WriteToProgressEvent](#WriteToProgressEvent) to true. Then, the [on_progress](#on_progress-event-sevenzip-struct) event may be trapped to retrieve the data. **Example (Creating an Archive)** ```text ZipControl.ArchiveFile = "c:\test.zip" ZipControl.RecurseSubdirectories = true ZipControl.IncludeFiles("c:\foo\*") ZipControl.Compress() ``` **Example (Extracting from an Archive)** ```text ZipControl.ArchiveFile = "c:\temp.zip" ZipControl.ExtractToPath = "c:\extracted\" ZipControl.ExtractAll() ``` ### Object Lifetime The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksZip. Due to this, the SevenZip struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of SevenZip 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.* | | | | --- | --- | | [archive_file](#archive_file-property-sevenzip-struct) | The name of the zip, gzip, tar, or jar archive. | | [compression_level](#compression_level-property-sevenzip-struct) | The compression level to use. | | [compression_method](#compression_method-property-sevenzip-struct) | Used to set the method of compression. | | [excluded_files](#excluded_files-property-sevenzip-struct) | A list of files to exclude. | | [extract_to_path](#extract_to_path-property-sevenzip-struct) | A base path to decompress to. | | [file_count](#file_count-property-sevenzip-struct) | The number of records in the File arrays. | | [file_attributes](#file_attributes-property-sevenzip-struct) | The attributes of the files to be compressed or decompressed. | | [file_compressed_date](#file_compressed_date-property-sevenzip-struct) | The date and time of the entry, as stored within the archive. | | [file_compressed_name](#file_compressed_name-property-sevenzip-struct) | The file name of the current file, as stored inside of the archive. | | [file_compressed_size](#file_compressed_size-property-sevenzip-struct) | The size of the compressed data, as compressed within the archive. | | [file_compression_level](#file_compression_level-property-sevenzip-struct) | The compression level to use for the file. | | [file_compression_method](#file_compression_method-property-sevenzip-struct) | This property specifies the compression method used for the individual file. | | [file_crc](#file_crc-property-sevenzip-struct) | The CRC value for the specified file found in the archive. | | [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) | The name of the file in the archive, as stored on the file system, outside the archive. | | [file_decompressed_size](#file_decompressed_size-property-sevenzip-struct) | The size of the file, as decompressed outside the archive. | | [file_input_data](#file_input_data-property-sevenzip-struct) | When This property is set, the struct will read in the data from This property instead of reading from the file contained in the DecompressedName property. | | [overwrite_files](#overwrite_files-property-sevenzip-struct) | Whether or not to overwrite files. | | [password](#password-property-sevenzip-struct) | A password for the zip archive. | | [recurse_subdirectories](#recurse_subdirectories-property-sevenzip-struct) | Whether or not to recurse into subdirectories. | | [seven_zip_data](#seven_zip_data-property-sevenzip-struct) | (Decompression only) The seven zip file contents as a byte array. | ## Method List *The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [abort](#abort-method-sevenzip-struct) | Aborts the current operation. | | [append_files](#append_files-method-sevenzip-struct) | Adds specified files to an existing archive. | | [compress](#compress-method-sevenzip-struct) | Creates the compressed archive. | | [config](#config-method-sevenzip-struct) | Sets or retrieves a configuration setting. | | [delete](#delete-method-sevenzip-struct) | Deletes one or more files from an existing archive. | | [extract](#extract-method-sevenzip-struct) | Extracts a single file, directory, or group of files, from the archive. | | [extract_all](#extract_all-method-sevenzip-struct) | Extracts all files from the compressed archive. | | [include_files](#include_files-method-sevenzip-struct) | Specifies that the indicated files should be added to the archive. | | [reset](#reset-method-sevenzip-struct) | Resets the struct. | | [scan](#scan-method-sevenzip-struct) | Scans the compressed archive. | | [update](#update-method-sevenzip-struct) | Will update certain files in an archive. | ## 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.* | | | | --- | --- | | [on_begin_file](#on_begin_file-event-sevenzip-struct) | Fired before each file is processed. | | [on_end_file](#on_end_file-event-sevenzip-struct) | Fired after each file is processed. | | [on_error](#on_error-event-sevenzip-struct) | Information about non-fatal errors. | | [on_overwrite](#on_overwrite-event-sevenzip-struct) | Fired whenever a file exists and may be overwritten. | | [on_progress](#on_progress-event-sevenzip-struct) | Fired as progress is made. | ## Config Settings *The following is a list of config settings for the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [BeginFileOnUpdate](#BeginFileOnUpdate) | Enables or disables events firing when updating existing archives. | | [CheckForFileLocks](#CheckForFileLocks) | If true, the struct requests an exclusive lock during initialization. | | [EnableFilter](#EnableFilter) | Enables or disables compression filters for executable files. | | [EnableHeaderCompression](#EnableHeaderCompression) | Enables or disables archive header compression. | | [EnableHeaderEncryption](#EnableHeaderEncryption) | Enables or disables archive header encryption. | | [ExcludedAttributes](#ExcludedAttributes) | Attributes of files to be excluded. | | [ExtractFilesOnly](#ExtractFilesOnly) | Whether to only extract the files contained within the archive. | | [FileNamesCaseSensitive](#FileNamesCaseSensitive) | This config controls the case-sensitivity of the struct when working with filenames. | | [IsEncrypted](#IsEncrypted) | Indicates whether the archive is encrypted. | | [OverwriteReadonlyFiles](#OverwriteReadonlyFiles) | Whether to overwrite readonly files. | | [TempPath](#TempPath) | A temporary directory where data can be stored during processing. | | [WriteToProgressEvent](#WriteToProgressEvent) | Whether or not to write data to the Progress Event. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # archive_file property ([SevenZip](#struct-ipworkszipsevenzip) Struct) The name of the zip, gzip, tar, or jar archive. ## Syntax *Rust Syntax* ```text fn archive_file(&self ) -> Result fn set_archive_file(&self, value : &str) -> Option fn set_archive_file_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property specifies the name of the archive to be read or written. This property is required when extracting files. When [scan](#scan-method-sevenzip-struct), [extract](#extract-method-sevenzip-struct), or [extract_all](#extract_all-method-sevenzip-struct) is invoked, the file specified by archive_file will be opened for read. If the file does not exist, a trappable error will be generated. When [compress](#compress-method-sevenzip-struct) is called, the file named by archive_file will be written; if a file of this name already exists the [on_overwrite](#on_overwrite-event-sevenzip-struct) event will be fired. If archive_file is set to the empty string (""), the archive will not be written to disk, and will be provided only through the [on_progress](#on_progress-event-sevenzip-struct) event. The filename may be specified with or without a path. Paths may be relative or absolute, and should be specified in the format native to the host operating system. The filename should be specified with the appropriate extension (such as "zip"); an extension will not automatically be appended by the struct. If the file cannot be read, or written, as appropriate, a trappable error will be generated. **Example (Creating an Archive)** ```text ZipControl.ArchiveFile = "c:\test.zip" ZipControl.RecurseSubdirectories = true ZipControl.IncludeFiles("c:\foo\*") ZipControl.Compress() ``` NOTE: an archive already open for read may be closed by setting archive_file to the empty string (""). ## Data Type String # compression_level property ([SevenZip](#struct-ipworkszipsevenzip) Struct) The compression level to use. ## Syntax *Rust Syntax* ```text fn compression_level(&self ) -> Result fn set_compression_level(&self, value : i32) -> Option ``` ## Default Value 3 ## Remarks This property is only applicable when using the LZMA [compression_method](#compression_method-property-sevenzip-struct). This property specifies the level of compression to be used,valid values are: 1, 2, 3, 4 and 5. Higher values will cause the struct to compress better; lower values will cause the struct to compress faster. The default value is 3. You may optionally set this property from within the [on_begin_file](#on_begin_file-event-sevenzip-struct) event to apply different levels of compression to different files. ## Data Type i32 # compression_method property ([SevenZip](#struct-ipworkszipsevenzip) Struct) Used to set the method of compression. ## Syntax *Rust Syntax* ```text fn compression_method(&self ) -> Result fn set_compression_method(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Lzma1 // Bzip22 // Delta3 // Copy4 // Deflate5 // Lzma2 ``` ## Default Value 0 ## Remarks This is used to specify different compression methods. By default the struct uses the LZMA compression method (a value of 0). Supported values are: | | | | --- | --- | | Value | Method | | cmszLzma (0 - default) | LZMA | | cmszBzip2 (1) | BZip2 | | cmszDelta (2) | Delta | | cmszCopy (3) | Copy (no compression) | | cmszDeflate (4) | Deflate | | cmszLzma2 (5) | LZMA2 | ## Data Type i32 # excluded_files property ([SevenZip](#struct-ipworkszipsevenzip) Struct) A list of files to exclude. ## Syntax *Rust Syntax* ```text fn excluded_files(&self ) -> Result fn set_excluded_files(&self, value : &str) -> Option fn set_excluded_files_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property specifies files that should be excluded when [compress](#compress-method-sevenzip-struct) or [extract](#extract-method-sevenzip-struct) is invoked. When [compress](#compress-method-sevenzip-struct) is invoked, each value of [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) in files will be compared to excluded_files, and each file will be excluded if the name matches. When [extract](#extract-method-sevenzip-struct) is called, each value of [file_compressed_name](#file_compressed_name-property-sevenzip-struct) in files matching the parameter to [extract](#extract-method-sevenzip-struct) will be compared to excluded_files, and will be excluded if appropriate. Calling the [extract_all](#extract_all-method-sevenzip-struct) method will ignore this property and extract all files in the archive. This property may be set to one or more filenames or directory names. Files may be specified with or without a path, and with or without wildcards. If a path is specified, files in the indicated directory will be excluded; subdirectories will be recursed into if [recurse_subdirectories](#recurse_subdirectories-property-sevenzip-struct) is true. If no path is specified but wildcards are, matching files in all directories will be excluded. If a single filename without a path is specified, it must correspond exactly to the appropriate value of [file_compressed_name](#file_compressed_name-property-sevenzip-struct) or [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct). Directories should end with a slash ("/" or "\", as appropriate.) If a directory is specified, all files and subdirectories in the specified directory will be excluded. A pipe character ("|") should be used to separate multiple file or directory names. The following examples illustrate the use of the property: **Example** ```text ZipControl.ArchiveFile = "c:\test.zip" ZipControl.IncludeFiles("c:\test\*") ZipControl.ExcludedFiles = "*.tmp" ZipControl.Compress() ``` **Example** ```text ZipControl.ArchiveFile = "c:\test.tar" ZipControl.Scan() ZipControl.ExcludedFiles = "*.bak | backup/" ZipControl.ExtractToPath = "c:\temp" ZipControl.Extract("*") ``` As per the examples, the property should be specified differently for compression and decompression. When invoking [compress](#compress-method-sevenzip-struct), the format of excluded_files should correspond to that of the local file system. When invoking [extract](#extract-method-sevenzip-struct) the format should correspond to standard (UNIX) format, and should not contain drive letters or backslashes. You may exclude files based on their *attributes* as well: See the *ExcludedAttributes* configuration setting for more information. If the property is set to the empty string, no files will be excluded. This property is never reset automatically, so be sure to reset it manually if using a single instance of the struct for both compression and extraction. Failure to do so may result in I/O errors or unexpected results. ## Data Type String # extract_to_path property ([SevenZip](#struct-ipworkszipsevenzip) Struct) A base path to decompress to. ## Syntax *Rust Syntax* ```text fn extract_to_path(&self ) -> Result fn set_extract_to_path(&self, value : &str) -> Option fn set_extract_to_path_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Setting the extract_to_path property affects the operation of the [extract](#extract-method-sevenzip-struct) and [extract_all](#extract_all-method-sevenzip-struct) methods. Setting this property to a nonempty string will cause all decompressed files to be written to the specified path. If pathnames are given in the values of [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) they will be regarded as relative to extract_to_path. If the specified directory does not exist, it will be created when extraction is done. extract_to_path should always be specified in the format native to the host operating system, and with a trailing slash or backslash. If the path is specified otherwise, it will be immediately converted and stored in the converted format. For example, "/temp" would be immediately converted to "\temp\" on a Windows system. **Example (Extracting from an Archive)** ```text ZipControl.ArchiveFile = "c:\temp.zip" ZipControl.ExtractToPath = "c:\extracted\" ZipControl.ExtractAll() ``` **Example - Adding Files** ```text Dim i as Integer ZipControl.ArchiveFile = "c:\test.zip" ZipControl.Scan() For i = 0 to ZipControl.Files.Count - 1 ZipControl.Files(i).DecompressedName(i) = "c:\temp\" + ZipControl.Files(i).DecompressedName Next i ZipControl.ExtractToPath = "" ZipControl.ExtractAll() ZipControl.IncludeFiles("c:\extra\*") ZipControl.Compress() ``` ## Data Type String # file_count property ([SevenZip](#struct-ipworkszipsevenzip) Struct) The number of records in the File arrays. ## Syntax *Rust Syntax* ```text fn file_count(&self ) -> Result fn set_file_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [file_attributes](#file_attributes-property-sevenzip-struct) - [file_compressed_date](#file_compressed_date-property-sevenzip-struct) - [file_compressed_name](#file_compressed_name-property-sevenzip-struct) - [file_compressed_size](#file_compressed_size-property-sevenzip-struct) - [file_compression_level](#file_compression_level-property-sevenzip-struct) - [file_compression_method](#file_compression_method-property-sevenzip-struct) - [file_crc](#file_crc-property-sevenzip-struct) - [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) - [file_decompressed_size](#file_decompressed_size-property-sevenzip-struct) - [file_input_data](#file_input_data-property-sevenzip-struct) The array indices start at *0* and end at *file_count - 1*. ## Data Type i32 # file_attributes property ([SevenZip](#struct-ipworkszipsevenzip) Struct) The attributes of the files to be compressed or decompressed. ## Syntax *Rust Syntax* ```text fn file_attributes(&self , FileIndex : i32) -> Result fn set_file_attributes(&self, FileIndex : i32, value : i32) -> Option ``` ## Default Value 0 ## Remarks The attributes of the files to be compressed or decompressed. It will then be written to the archive during compression and to the file system during extraction. If desired, you may change the value of **Attributes** before compressing or decompressing. The property is a bitmask of flags, corresponding to the MS-DOS directory byte: | | | | --- | --- | | Readonly | 1 | | Hidden | 2 | | System | 4 | | Directory | 16 | | Archive | 32 | In the **Java Edition**, due to limitations of the JRE, the effect of this property is limited. When including files, only the *Hidden* and *Readonly* bits will be read from the file system, and during extraction only the *Readonly* attribute will be written. The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#file_count-property-sevenzip-struct) property. ## Data Type i32 # file_compressed_date property ([SevenZip](#struct-ipworkszipsevenzip) Struct) The date and time of the entry, as stored within the archive. ## Syntax *Rust Syntax* ```text fn file_compressed_date(&self , FileIndex : i32) -> Result fn set_file_compressed_date(&self, FileIndex : i32, value : i64) -> Option ``` ## Default Value 0 ## Remarks The date and time of the entry, as stored within the archive. **FileCompressedDate** contains the last modified date of the file, as stored within the archive (it does not generally correspond to when the file was compressed). **FileCompressedDate** is returned in a platform-specific format. The **Java**,**C++**, and most other Editions will return the number of milliseconds since January 1, 1970, 00:00:00. This value may be passed directly to the *java.util.Date* constructor to create a *java.util.Date* object representing this date. The **.NET** Edition will return the number of ticks, or 100-nanosecond intervals, since January 1, 0001, 00:00:00. This value may be passed directly to the *System.DateTime* constructor to create a *System.DateTime* object representing this date. Reading the value of this property will return a meaningful value only after the archive has been successfully scanned or decompressed, and only if the values of archive_file, files collection, and [file_compressed_name](#file_compressed_name-property-sevenzip-struct) have not been changed since. If a meaningful value is not available this property will return a value of 0. NOTE: This may be set accordingly when the [file_input_stream](#SevenZip_p_FileInputStream) property is set to a valid stream to input the data for the current file. If not set, the default, 0, is used. Otherwise the value is read from disk. The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#file_count-property-sevenzip-struct) property. ## Data Type i64 # file_compressed_name property ([SevenZip](#struct-ipworkszipsevenzip) Struct) The file name of the current file, as stored inside of the archive. ## Syntax *Rust Syntax* ```text fn file_compressed_name(&self , FileIndex : i32) -> Result fn set_file_compressed_name(&self, FileIndex : i32, value : &str) -> Option fn set_file_compressed_name_ref(&self, FileIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The file name of the current file, as stored inside of the archive. This may be the same as in [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct), but is not required to be. All paths are stored in the archive in standard (UNIX) format. Pathnames specified in the host operating system's format will be immediately converted. This field should generally be set with a relative path or with no path at all. The exact interpretation of the path is left to the decompression software; generally, pathnames will be interpreted as relative to a base directory, and these subdirectories will be created as needed. Absolute pathnames (paths beginning with a */* character) will not be interpreted correctly by the struct, and may or may not be interpreted correctly by other decompression software. Paths should be specified in standard (UNIX) format. They may also be specified in the format native to the host operating system, in which case they will be immediately converted. **Example** ```text ZipControl.ArchiveFile = "c:\test.zip" ZipControl.Files.Add(new ZIPFile()) ZipControl.Files[0].DecompressedName = "c:\test\ipworkszip\temp\test.txt" ZipControl.Files[0].CompressedName = "readme.txt" ZipControl.Compress() ``` The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#file_count-property-sevenzip-struct) property. ## Data Type String # file_compressed_size property ([SevenZip](#struct-ipworkszipsevenzip) Struct) The size of the compressed data, as compressed within the archive. ## Syntax *Rust Syntax* ```text fn file_compressed_size(&self , FileIndex : i32) -> Result ``` ## Default Value -1 ## Remarks The size of the compressed data, as compressed within the archive. Headers, footers, etc., are not included in the size. Reading the value of this property will return a meaningful value only after the archive has been compressed, and only if the values of [archive_file](#archive_file-property-sevenzip-struct), or [files](#SevenZip_p_Files) have not been changed since. The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#file_count-property-sevenzip-struct) property. This property is read-only. ## Data Type i64 # file_compression_level property ([SevenZip](#struct-ipworkszipsevenzip) Struct) The compression level to use for the file. ## Syntax *Rust Syntax* ```text fn file_compression_level(&self , FileIndex : i32) -> Result fn set_file_compression_level(&self, FileIndex : i32, value : i32) -> Option ``` ## Default Value -1 ## Remarks The compression level to use for the file. This property specifies the level of compression to be used, valid values are 1, 2, 3, 4 and 5. Higher values will cause the struct to compress better; lower values will cause the struct to compress faster. The default value is -1, which means the value specified in the [compression_level](#compression_level-property-sevenzip-struct) property will be used. The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#file_count-property-sevenzip-struct) property. ## Data Type i32 # file_compression_method property ([SevenZip](#struct-ipworkszipsevenzip) Struct) This property specifies the compression method used for the individual file. ## Syntax *Rust Syntax* ```text fn file_compression_method(&self , FileIndex : i32) -> Result fn set_file_compression_method(&self, FileIndex : i32, value : i32) -> Option ``` ## Possible Values ```text 0 // Lzma1 // Bzip22 // Delta3 // Copy4 // Deflate5 // Lzma2 ``` ## Default Value 0 ## Remarks This property specifies the compression method used for the individual file. The compression method set here is applicable to this file only. Possible values are: | | | | --- | --- | | Value | Method | | cmszLzma (0 - default) | LZMA | | cmszBzip2 (1) | BZip2 | | cmszDelta (2) | Delta | | cmszCopy (3) | Copy (no compression) | | cmszDeflate (4) | Deflate | | cmszDeflate (5) | LZMA2 | If this property is not set, the method specified by the [compression_method](#compression_method-property-sevenzip-struct) property will be used. Note that different files in the archive may use different compression methods. The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#file_count-property-sevenzip-struct) property. ## Data Type i32 # file_crc property ([SevenZip](#struct-ipworkszipsevenzip) Struct) The CRC value for the specified file found in the archive. ## Syntax *Rust Syntax* ```text fn file_crc(&self , FileIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The [file_crc](#file_crc-property-sevenzip-struct) value for the specified file found in the archive. This value is populated after compression or decompression. The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#file_count-property-sevenzip-struct) property. This property is read-only. ## Data Type i64 # file_decompressed_name property ([SevenZip](#struct-ipworkszipsevenzip) Struct) The name of the file in the archive, as stored on the file system, outside the archive. ## Syntax *Rust Syntax* ```text fn file_decompressed_name(&self , FileIndex : i32) -> Result fn set_file_decompressed_name(&self, FileIndex : i32, value : &str) -> Option fn set_file_decompressed_name_ref(&self, FileIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The name of the file in the archive, as stored on the file system, outside the archive. When compressing files, This property should be specified with a path, if necessary, to allow the file to be found by the struct. If the file cannot be found during compression, a trappable error will be generated, and the archive will not be correctly written. When decompressing files, the property indicates where the file should be written. After the archive is scanned, the values of [file_compressed_name](#file_compressed_name-property-sevenzip-struct) and **DecompressedName** will be set to the exact filenames found in the archive. The value of **DecompressedName** may then be changed if desired. If **DecompressedName** is set to an empty string before extraction, the file will not be written to disk at all. It will still be written to the **Progress** event if WriteToProgressEvent is set to true. If **DecompressedName** is set to an empty string before compression, the file will be skipped, and not written to the archive. A base path for decompression may be specified by setting the extract_to_path property. If extract_to_path is set to a non-empty string, the files will be decompressed to the directory specified in extract_to_path. If the value of [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) contains a pathname it will be regarded as relative to extract_to_path. Paths on the local file system should be specified in the format native to the host operating system. They may also be specified in standard (UNIX) format, in which case they will be immediately converted. **Example** ```text ZipControl.ArchiveFile = "c:\test.tar" ZipControl.Scan() ZipControl.ExtractToPath = "c:\temp\" ZipControl.Files[1].DecompressedName = "test\temp.out" ZipControl.Extract(ZipControl.Files[1].CompressedName) ``` **Incorrect Example** ```text ZipControl.ExtractToPath = "c:\temp\" ZipControl.Files[1].DecompressedName = "c:\temp\test\temp.out" 'The file would be extracted to c:\temp\c:\temp\test\temp.out ``` The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#file_count-property-sevenzip-struct) property. ## Data Type String # file_decompressed_size property ([SevenZip](#struct-ipworkszipsevenzip) Struct) The size of the file, as decompressed outside the archive. ## Syntax *Rust Syntax* ```text fn file_decompressed_size(&self , FileIndex : i32) -> Result ``` ## Default Value -1 ## Remarks The size of the file, as decompressed outside the archive. If an archive is open for read (i.e. has been scanned or decompressed), this information will be read from the archive headers. If an archive is not open for read, the struct will retrieve the information for the corresponding value of [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) from the local file system. A value of -1 will be returned in case of an I/O error. The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#file_count-property-sevenzip-struct) property. This property is read-only. ## Data Type i64 # file_input_data property ([SevenZip](#struct-ipworkszipsevenzip) Struct) When This property is set, the struct will read in the data from This property instead of reading from the file contained in the DecompressedName property. ## Syntax *Rust Syntax* ```text fn file_input_data(&self , FileIndex : i32) -> Result, IPWorksZipError> fn set_file_input_data(&self, FileIndex : i32, value : Vec) -> Option fn set_file_input_data_ref(&self, FileIndex : i32, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks When This property is set, the struct will read in the data from This property instead of reading from the file contained in the [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) property. The *FileIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [FileCount](#file_count-property-sevenzip-struct) property. ## Data Type Vec # overwrite_files property ([SevenZip](#struct-ipworkszipsevenzip) Struct) Whether or not to overwrite files. ## Syntax *Rust Syntax* ```text fn overwrite_files(&self ) -> Result fn set_overwrite_files(&self, value : bool) -> Option ``` ## Default Value true ## Remarks If this property is set to true, existing files will be overwritten when decompressing. When [extract](#extract-method-sevenzip-struct) or [extract_all](#extract_all-method-sevenzip-struct) is called, each file specified in files will be checked for existence. If a file exists, the [on_overwrite](#on_overwrite-event-sevenzip-struct) event will be fired, and the files will be overwritten if overwrite_files is set to true. More precise control of which files should be overwritten may be gained by listening to the [on_overwrite](#on_overwrite-event-sevenzip-struct) event and altering its parameters when the event is fired. This property only affects the operation of [extract](#extract-method-sevenzip-struct) and [extract_all](#extract_all-method-sevenzip-struct). When compressing files, [archive_file](#archive_file-property-sevenzip-struct) will always be overwritten unless the user specifies otherwise in the [on_overwrite](#on_overwrite-event-sevenzip-struct) event. ## Data Type bool # password property ([SevenZip](#struct-ipworkszipsevenzip) Struct) A password for the zip archive. ## Syntax *Rust Syntax* ```text fn password(&self ) -> Result fn set_password(&self, value : &str) -> Option fn set_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property specifies the case-sensitive password used to encrypt or decrypt the archive. If set to an empty string, no password is used. In this release, streaming out of encrypted archives is not supported. When compressing, [WriteToProgressEvent](#WriteToProgressEvent) must be set to false if password is set. **Example (Compressing an Archive)** ```text ZipControl.ArchiveFile = "c:\test.zip" ZipControl.RecurseSubdirectories = true ZipControl.IncludeFiles("c:\foo\*") ZipControl.Password = "nsoftware" ZipControl.Compress() ``` ## Data Type String # recurse_subdirectories property ([SevenZip](#struct-ipworkszipsevenzip) Struct) Whether or not to recurse into subdirectories. ## Syntax *Rust Syntax* ```text fn recurse_subdirectories(&self ) -> Result fn set_recurse_subdirectories(&self, value : bool) -> Option ``` ## Default Value true ## Remarks This property affects the behavior of [include_files](#include_files-method-sevenzip-struct) and [extract](#extract-method-sevenzip-struct) and the meaning of [excluded_files](#excluded_files-property-sevenzip-struct). If this property is set to true, [include_files](#include_files-method-sevenzip-struct) will recurse into all subdirectories whenever it performs a search on the file system. Be sure recurse_subdirectories is set to the appropriate value before invoking [include_files](#include_files-method-sevenzip-struct), [extract](#extract-method-sevenzip-struct), or [compress](#compress-method-sevenzip-struct); changing the value of this property after method calls will not retroactively alter their effects. **Example (Creating an Archive)** ```text ZipControl.ArchiveFile = "c:\test.zip" ZipControl.RecurseSubdirectories = true ZipControl.IncludeFiles("c:\foo\*") ZipControl.Compress() ``` ## Data Type bool # seven_zip_data property ([SevenZip](#struct-ipworkszipsevenzip) Struct) (Decompression only) The seven zip file contents as a byte array. ## Syntax *Rust Syntax* ```text fn set_seven_zip_data(&self, value : Vec) -> Option fn set_seven_zip_data_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks Normally you should set [archive_file](#archive_file-property-sevenzip-struct) before invoking [scan](#scan-method-sevenzip-struct) or [extract](#extract-method-sevenzip-struct). If you prefer to read the zip file from memory you may set zip_data instead. zip_data should be set to the entire contents of the zip file; this will allow you to read from the archive without writing any temporary files to disk. If you would like to extract data from the archive without ever writing to disk you should also set [WriteToProgressEvent](#WriteToProgressEvent) to true, and after invoking [scan](#scan-method-sevenzip-struct), you should set the value of [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) for each file in the files collection to an empty string. Then, when you invoke [extract](#extract-method-sevenzip-struct) (or [extract_all](#extract_all-method-sevenzip-struct)) the data will be provided in the [on_progress](#on_progress-event-sevenzip-struct) event. This property is write-only. Note that modifying a zip file stored in zip_data is not supported, so append, [delete](#delete-method-sevenzip-struct), etc., will throw exceptions. This property is write-only. ## Data Type Vec # abort method ([SevenZip](#struct-ipworkszipsevenzip) Struct) Aborts the current operation. ## Syntax *Rust Syntax* ```text fn abort(&self) -> Result<(), IPWorksZipError> ``` ## Remarks abort may be used to immediately interrupt compression or decompression. Any files partially written by the struct will be deleted. In case append or [delete](#delete-method-sevenzip-struct) is aborted the archive will be left in its original state. # append_files method ([SevenZip](#struct-ipworkszipsevenzip) Struct) Adds specified files to an existing archive. ## Syntax *Rust Syntax* ```text fn append_files(&self) -> Result<(), IPWorksZipError> ``` ## Remarks All files contained in the files collection will be appended to the archive specified by [archive_file](#archive_file-property-sevenzip-struct). When append_files is called, only those files which are to be added to the archive must exist inside the collection. Note that if you call [scan](#scan-method-sevenzip-struct) or [extract](#extract-method-sevenzip-struct), you must empty the collection before adding files to the collection to be appended. After the file is added, the collection will be updated appropriately. This method may only be used to add files to an existing archive. To add files to a new archive, the [include_files](#include_files-method-sevenzip-struct) and [compress](#compress-method-sevenzip-struct) methods should be used. # compress method ([SevenZip](#struct-ipworkszipsevenzip) Struct) Creates the compressed archive. ## Syntax *Rust Syntax* ```text fn compress(&self) -> Result<(), IPWorksZipError> ``` ## Remarks Invoking compress creates the archive specified by [archive_file](#archive_file-property-sevenzip-struct). When the method is called, all files specified by the [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) field of the files collection will be compressed and written to [archive_file](#archive_file-property-sevenzip-struct). The compressed data may be streamed out by setting [WriteToProgressEvent](#WriteToProgressEvent) to true. If streaming is enabled the compressed data will also be provided via the [on_progress](#on_progress-event-sevenzip-struct) event. If [archive_file](#archive_file-property-sevenzip-struct) is set to an empty string the archive will be written only to this event. The files to compress are specified in the files collection. The file names are specified by [file_compressed_name](#file_compressed_name-property-sevenzip-struct) and [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct). These should be specified before invoking compress, either manually or by invoking [include_files](#include_files-method-sevenzip-struct). The [on_begin_file](#on_begin_file-event-sevenzip-struct) and [on_end_file](#on_end_file-event-sevenzip-struct) events will be fired as files are processed, and the [on_progress](#on_progress-event-sevenzip-struct) event will be fired as data is compressed. Existing files will be overwritten by the struct if [overwrite_files](#overwrite_files-property-sevenzip-struct) is set to true. Finer control over which files are overwritten may be gained by trapping the [on_overwrite](#on_overwrite-event-sevenzip-struct) event. **Example (Creating an Archive)** ```text ZipControl.ArchiveFile = "c:\test.zip" ZipControl.RecurseSubdirectories = true ZipControl.IncludeFiles("c:\foo\*") ZipControl.Compress() ``` # config method ([SevenZip](#struct-ipworkszipsevenzip) Struct) Sets or retrieves a configuration setting. ## Syntax *Rust Syntax* ```text fn config(&self, configuration_string : &str) -> Result ``` ## Remarks config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-sevenzip-struct) 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](#config-settings-sevenzip-struct), you must call *Config("PROPERTY")*. The value will be returned as a string. # delete method ([SevenZip](#struct-ipworkszipsevenzip) Struct) Deletes one or more files from an existing archive. ## Syntax *Rust Syntax* ```text fn delete(&self, file_names : &str) -> Result<(), IPWorksZipError> ``` ## Remarks delete deletes one or more files from an existing archive, without reprocessing the compressed data. The archive will be opened immediately, and the file(s) will immediately be removed permanently from the archive. The list of filenames should be specified exactly as when calling [extract](#extract-method-sevenzip-struct): *Filenames* may be set to one or more filenames or directory names. Files may be specified with or without a path, and with or without wildcards. If a path is specified, files in the indicated directory will be affected; subdirectories will be recursed into if [recurse_subdirectories](#recurse_subdirectories-property-sevenzip-struct) is true. If no path is specified but wildcards are, matching files in all directories will be affected. If a single filename without a path is specified, it must correspond exactly to the appropriate value of [file_compressed_name](#file_compressed_name-property-sevenzip-struct). Directories should end with a slash ("/"). If a directory is specified, all files and subdirectories in the specified directory will be affected. A pipe character ("|") should be used to separate multiple file or directory names. Alternatively, the method may be invoked repeatedly. The [excluded_files](#excluded_files-property-sevenzip-struct) property may be used to further limit the files to be deleted. When delete is used to delete a directory or match wildcards, each file to be deleted is first compared against [excluded_files](#excluded_files-property-sevenzip-struct), and any files marked as excluded will not be deleted. When delete is used to delete a single file, the value of [excluded_files](#excluded_files-property-sevenzip-struct) will be ignored. When the method is invoked, the [scan](#scan-method-sevenzip-struct) method will first be invoked, if it has not been invoked already. Note that if [include_files](#include_files-method-sevenzip-struct) has been invoked, or if the values of [file_compressed_name](#file_compressed_name-property-sevenzip-struct) and [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) for each file in the files collection have been set, this information will be reset by the call to [scan](#scan-method-sevenzip-struct). When deleting multiple files, the struct will operate most efficiently if all filenames are passed to delete in a single invocation of the method. Invoking delete repeatedly on large archives is not recommended. Invoking delete will only remove files from [archive_file](#archive_file-property-sevenzip-struct); it will not delete the files from the disk. **Example** ```text ZipControl.ArchiveFile = "c:\\test.zip" ZipControl.Delete("default_readme.txt"); ZipControl.Append("\\mydir\\my_readme.txt", "my_readme.txt") ``` # extract method ([SevenZip](#struct-ipworkszipsevenzip) Struct) Extracts a single file, directory, or group of files, from the archive. ## Syntax *Rust Syntax* ```text fn extract(&self, file_names : &str) -> Result<(), IPWorksZipError> ``` ## Remarks extract extracts one or more files from the archive. The file(s) will be extracted to the directory specified by [extract_to_path](#extract_to_path-property-sevenzip-struct), and given the names found in the archive or specified by the [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) of the file in the files collection. *Filenames* may be set to one or more filenames or directory names. Files may be specified with or without a path, and with or without wildcards. If a path is specified, files in the indicated directory will be affected; subdirectories will be recursed into if [recurse_subdirectories](#recurse_subdirectories-property-sevenzip-struct) is true. If no path is specified but wildcards are, matching files in all directories will be affected. If a single filename without a path is specified, it must correspond exactly to the appropriate value of [file_compressed_name](#file_compressed_name-property-sevenzip-struct). Directories should end with a slash ("/"). If a directory is specified, all files and subdirectories in the specified directory will be affected. A pipe character ("|") should be used to separate multiple file or directory names. Alternatively, the method may be invoked repeatedly. The [excluded_files](#excluded_files-property-sevenzip-struct) property may be used to further limit the files to be extracted. When extract is used to extract a directory or match wildcards, each file to be extracted is first compared against [excluded_files](#excluded_files-property-sevenzip-struct), and any files marked as excluded will not be extracted. When extract is used to extract a single file, the value of [excluded_files](#excluded_files-property-sevenzip-struct) will be ignored. To extract all files in the archive, the [extract_all](#extract_all-method-sevenzip-struct) method may be used. The [on_begin_file](#on_begin_file-event-sevenzip-struct) and [on_end_file](#on_end_file-event-sevenzip-struct) events will be fired before and after each file is extracted, and the [on_progress](#on_progress-event-sevenzip-struct) event will be fired as the data is extracted. If [WriteToProgressEvent](#WriteToProgressEvent) is set to true, the decompressed data will be streamed out through the [on_progress](#on_progress-event-sevenzip-struct) event. **Example** ```text ZipControl.ArchiveFile = "c:\test.tar" ZipControl.ExcludedFiles = "*.bak | backup/" ZipControl.ExtractToPath = "c:\temp" ZipControl.Extract("*") ``` **Example** ```text ZipControl.ArchiveFile = "c:\test.zip" ZipControl.ExcludedFiles = "" ZipControl.ExtractToPath = "c:\temp" ZipControl.Extract("code/") ``` **Example** ```text ZipControl.ArchiveFile = "c:\test.jar" ZipControl.ExcludedFiles = "*.txt" ZipControl.ExtractToPath = "c:\" ZipControl.Extract("* | docs/readme.txt") ``` # extract_all method ([SevenZip](#struct-ipworkszipsevenzip) Struct) Extracts all files from the compressed archive. ## Syntax *Rust Syntax* ```text fn extract_all(&self) -> Result<(), IPWorksZipError> ``` ## Remarks extract_all extracts all files from the archive. The file(s) will be extracted to the directory specified by [extract_to_path](#extract_to_path-property-sevenzip-struct), and given the names found in the archive or specified by the [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) field of the file in the files collection. If [scan](#scan-method-sevenzip-struct) has not been invoked when extract_all is called, [scan](#scan-method-sevenzip-struct) will automatically be invoked, and the files collection will be set to the values found in the archive. To manually set the decompressed filenames, [scan](#scan-method-sevenzip-struct) should be invoked before setting the [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) field. Invoking this method is equivalent to setting [excluded_files](#excluded_files-property-sevenzip-struct) to the empty string, and then invoking [extract](#extract-method-sevenzip-struct) with "*" as the argument. Calling this method will cause the [excluded_files](#excluded_files-property-sevenzip-struct) property to be ignored; to extract all files except those specified by [excluded_files](#excluded_files-property-sevenzip-struct), call the [extract](#extract-method-sevenzip-struct) method with the wildcard "*" as the method parameter instead of calling this method. The [on_begin_file](#on_begin_file-event-sevenzip-struct) and [on_end_file](#on_end_file-event-sevenzip-struct) events will be fired before and after each file is extracted, and the [on_progress](#on_progress-event-sevenzip-struct) event will be fired as the data is extracted. If [WriteToProgressEvent](#WriteToProgressEvent) is set to true, the decompressed data will be streamed out through the [on_progress](#on_progress-event-sevenzip-struct) event. **Example (Extracting from an Archive)** ```text ZipControl.ArchiveFile = "c:\temp.zip" ZipControl.ExtractToPath = "c:\extracted\" ZipControl.ExtractAll() ``` # include_files method ([SevenZip](#struct-ipworkszipsevenzip) Struct) Specifies that the indicated files should be added to the archive. ## Syntax *Rust Syntax* ```text fn include_files(&self, file_names : &str) -> Result<(), IPWorksZipError> ``` ## Remarks include_files may be used before [compress](#compress-method-sevenzip-struct), to specify the files to be compressed. Invoking this method populates the files collection accordingly. Invoking the method does not create or alter the archive. The argument should be a pipe ("|") -delimited sequence of one or more filenames. The filenames should be specified with paths if necessary, so that the files may be found on the local file system. The filenames will be stored as is in the [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) field, and without a pathname in the [file_compressed_name](#file_compressed_name-property-sevenzip-struct) field of the files collection. Filenames may include the wildcards '?', '*', and '[ .. ]'. '?' will match any single character, and '*' will match an arbitrary sequence of characters. '[ .. ]' may be used to match any of the characters inside, or a range, such as '[a-z]'. A '\' can be used to escape wildcard characters. If wildcards are specified, the file system will be scanned and all files matching the specified mask will be added. Moreover, subdirectories will be recursed into if [recurse_subdirectories](#recurse_subdirectories-property-sevenzip-struct) is set to true. When recursing into subdirectories, relative path information will be stored in [file_compressed_name](#file_compressed_name-property-sevenzip-struct) field of the files collection. The [excluded_files](#excluded_files-property-sevenzip-struct) may be used to limit the files to be compressed. This property is checked when [compress](#compress-method-sevenzip-struct) is invoked, rather than when include_files is invoked, so this property may be set before or after invoking include_files. Note that invoking include_files will not reset the struct, or remove old values of [file_compressed_name](#file_compressed_name-property-sevenzip-struct) and [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct). This may be done by first clearing the files collection. **Example** ```text ZipControl.IncludeFiles("c:\test\* | c:\readme") ZipControl.ExcludedFiles = "*.tmp" ZipControl.Compress() ``` # reset method ([SevenZip](#struct-ipworkszipsevenzip) Struct) Resets the struct. ## Syntax *Rust Syntax* ```text fn reset(&self) -> Result<(), IPWorksZipError> ``` ## Remarks reset resets the state of the struct. The files collection will be cleared, all properties will be set to their default values, and any files open will be closed. # scan method ([SevenZip](#struct-ipworkszipsevenzip) Struct) Scans the compressed archive. ## Syntax *Rust Syntax* ```text fn scan(&self) -> Result<(), IPWorksZipError> ``` ## Remarks This method will scan the archive specified by [archive_file](#archive_file-property-sevenzip-struct). The number of files and their names and sizes will be determined and written to the files collection. After scanning the archive, the values of [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) may be changed if desired, and any number of files may be decompressed. The [extract](#extract-method-sevenzip-struct) method allows you to decompress files of your choice, and the [extract_all](#extract_all-method-sevenzip-struct) method will decompress the entire archive. Changing the values of the [file_compressed_name](#file_compressed_name-property-sevenzip-struct) field or the number of files in the files collection will invalidate the scan. If either of these is changed and [extract](#extract-method-sevenzip-struct) or [extract_all](#extract_all-method-sevenzip-struct) is then called; scan will automatically be called again, and these values will be reset to their original values. Calling this method will frequently generate a trappable error if the archive is corrupt. This is not guaranteed, however, as scan only examines the headers. **Example** ```text Dim i As Integer ZipControl.ArchiveFile = "c:\temp.zip" ZipControl.Scan For i = 0 To ZipControl.FileCount - 1 Debug.Print "File Name: " & ZipControl.FileDecompressedName(i) Debug.Print "File Size: " & ZipControl.FileDecompressedSize(i) Next i ``` # update method ([SevenZip](#struct-ipworkszipsevenzip) Struct) Will update certain files in an archive. ## Syntax *Rust Syntax* ```text fn update(&self, file_names : &str) -> Result<(), IPWorksZipError> ``` ## Remarks When this method is called, the struct will attempt to update files in the specified archive with the current files listed in the files collection. You may use the *file_names* parameter to tell the struct which files in the collection/archive must be updated. *Filenames* may be set to one or more filenames or directory names. Files may be specified with or without a path, and with or without wildcards. If a path is specified, files in the indicated directory will be affected; subdirectories will be recursed into if [recurse_subdirectories](#recurse_subdirectories-property-sevenzip-struct) is true. If no path is specified but wildcards are, matching files in all directories will be affected. If a single filename without a path is specified, it must correspond exactly to the appropriate value of [file_compressed_name](#file_compressed_name-property-sevenzip-struct). Directories should end with a slash ("/"). If a directory is specified, all files and subdirectories in the specified directory will be affected. A pipe character ("|") should be used to separate multiple file or directory names. Alternatively, the method may be invoked repeatedly. If [BeginFileOnUpdate](#BeginFileOnUpdate) is set to True, [on_begin_file](#on_begin_file-event-sevenzip-struct) and [on_end_file](#on_end_file-event-sevenzip-struct) will fire before and after updating each specified file listed in the files collection; # on_begin_file event ([SevenZip](#struct-ipworkszipsevenzip) Struct) Fired before each file is processed. ## Syntax *Rust Syntax* ```text // SevenZipBeginFileEventArgs carries the SevenZip BeginFile event's parameters. pub struct SevenZipBeginFileEventArgs { fn index(&self) -> i32 fn skip(&self) -> bool fn set_skip(&self, value : bool) } // SevenZipBeginFileEvent defines the signature of the SevenZip BeginFile event's handler function. pub trait SevenZipBeginFileEvent { fn on_begin_file(&self, sender : SevenZip, e : &mut SevenZipBeginFileEventArgs); } impl <'a> SevenZip<'a> { pub fn on_begin_file(&self) -> &'a dyn SevenZipBeginFileEvent; pub fn set_on_begin_file(&mut self, value : &'a dyn SevenZipBeginFileEvent); ... } ``` ## Remarks on_begin_file is fired before each file is processed by the compressor or decompressor, as appropriate. *index* contains the array index of the file about to be processed, and the [file_compressed_name](#file_compressed_name-property-sevenzip-struct), [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct), [file_compressed_size](#file_compressed_size-property-sevenzip-struct) (decompression only), and [file_decompressed_size](#file_decompressed_size-property-sevenzip-struct) fields of the files collection for this index contain more detailed information about the file about to be processed. When extracting, an alternate location may be specified by trapping the event, and modifying [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) and/or [extract_to_path](#extract_to_path-property-sevenzip-struct). If the appropriate value of [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct) is set to an empty string, the file will not be written to disk. If [WriteToProgressEvent](#WriteToProgressEvent) is true, the file will still be decompressed, and the data may be extracted through the [on_progress](#on_progress-event-sevenzip-struct) event. This event may also be trapped while compressing. [file_attributes](#file_attributes-property-sevenzip-struct), [file_compressed_name](#file_compressed_name-property-sevenzip-struct), [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct), and [file_compressed_date](#file_compressed_date-property-sevenzip-struct) may be changed. You may set the *skip* parameter to true in order to skip the file completely while compressing or extracting. # on_end_file event ([SevenZip](#struct-ipworkszipsevenzip) Struct) Fired after each file is processed. ## Syntax *Rust Syntax* ```text // SevenZipEndFileEventArgs carries the SevenZip EndFile event's parameters. pub struct SevenZipEndFileEventArgs { fn index(&self) -> i32 } // SevenZipEndFileEvent defines the signature of the SevenZip EndFile event's handler function. pub trait SevenZipEndFileEvent { fn on_end_file(&self, sender : SevenZip, e : &mut SevenZipEndFileEventArgs); } impl <'a> SevenZip<'a> { pub fn on_end_file(&self) -> &'a dyn SevenZipEndFileEvent; pub fn set_on_end_file(&mut self, value : &'a dyn SevenZipEndFileEvent); ... } ``` ## Remarks on_end_file is fired after each file is processed by the compressor or decompressor, as appropriate. *index* contains the array index of the file processed, and the [file_compressed_name](#file_compressed_name-property-sevenzip-struct), [file_decompressed_name](#file_decompressed_name-property-sevenzip-struct), [file_compressed_size](#file_compressed_size-property-sevenzip-struct), and [file_decompressed_size](#file_decompressed_size-property-sevenzip-struct) fields in the files collection for this index contain more detailed information about the file processed. # on_error event ([SevenZip](#struct-ipworkszipsevenzip) Struct) Information about non-fatal errors. ## Syntax *Rust Syntax* ```text // SevenZipErrorEventArgs carries the SevenZip Error event's parameters. pub struct SevenZipErrorEventArgs { fn description(&self) -> &String fn error_code(&self) -> i32 fn index(&self) -> i32 fn file_name(&self) -> &String fn ignore(&self) -> bool fn set_ignore(&self, value : bool) } // SevenZipErrorEvent defines the signature of the SevenZip Error event's handler function. pub trait SevenZipErrorEvent { fn on_error(&self, sender : SevenZip, e : &mut SevenZipErrorEventArgs); } impl <'a> SevenZip<'a> { pub fn on_error(&self) -> &'a dyn SevenZipErrorEvent; pub fn set_on_error(&mut self, value : &'a dyn SevenZipErrorEvent); ... } ``` ## Remarks The on_error event is fired when non-fatal errors occur during compression or decompression. Note that if this event is fired during decompression this may indicate that the archive is corrupt. By default these errors will cause the component to fail with an exception. The exception may be overridden by setting *ignore* to true. This will cause the error to be ignored, the file will be skipped if necessary, and the struct will continue operation. *error_code* will correspond to one of the following errors: | | | | --- | --- | | 1 | Bad or missing CRC-32 checksum. | | 2 | Failed to set creation date of a file. | | 111 | Can't open file for read (skipping). | *description* contains a textual description of the error. *index* and *file_name* contain the array index (where appropriate) and filename of the file being processed at the time of the error. # on_overwrite event ([SevenZip](#struct-ipworkszipsevenzip) Struct) Fired whenever a file exists and may be overwritten. ## Syntax *Rust Syntax* ```text // SevenZipOverwriteEventArgs carries the SevenZip Overwrite event's parameters. pub struct SevenZipOverwriteEventArgs { fn file_name(&self) -> &String fn set_file_name(&self, value : &str) fn set_file_name_ref(&self, value : &String) fn overwrite(&self) -> bool fn set_overwrite(&self, value : bool) } // SevenZipOverwriteEvent defines the signature of the SevenZip Overwrite event's handler function. pub trait SevenZipOverwriteEvent { fn on_overwrite(&self, sender : SevenZip, e : &mut SevenZipOverwriteEventArgs); } impl <'a> SevenZip<'a> { pub fn on_overwrite(&self) -> &'a dyn SevenZipOverwriteEvent; pub fn set_on_overwrite(&mut self, value : &'a dyn SevenZipOverwriteEvent); ... } ``` ## Remarks on_overwrite is fired when a file is about to be overwritten, and would overwrite an existing file. The event is fired during decompression. *file_name* contains the full name of the file, specified with its pathname. *overwrite* specifies whether or not the file will be overwritten. For Zip, Jar, and Tar, this is equal by default to the value of the [overwrite_files](#overwrite_files-property-sevenzip-struct) property. For Gzip, this value defaults to true. Either of the parameters may be changed when the event is fired. Changing the value of *overwrite* will override the default behavior of the struct, and cause the file to be overwritten or not overwritten, depending on the value set. If *file_name* is changed, the value of *overwrite* will be ignored, and the file will be written with the specified name. If a file of the new name also exists this file will be silently overwritten. # on_progress event ([SevenZip](#struct-ipworkszipsevenzip) Struct) Fired as progress is made. ## Syntax *Rust Syntax* ```text // SevenZipProgressEventArgs carries the SevenZip Progress event's parameters. pub struct SevenZipProgressEventArgs { fn data(&self) -> &[u8] fn file_name(&self) -> &String fn bytes_processed(&self) -> i64 fn percent_processed(&self) -> i32 } // SevenZipProgressEvent defines the signature of the SevenZip Progress event's handler function. pub trait SevenZipProgressEvent { fn on_progress(&self, sender : SevenZip, e : &mut SevenZipProgressEventArgs); } impl <'a> SevenZip<'a> { pub fn on_progress(&self) -> &'a dyn SevenZipProgressEvent; pub fn set_on_progress(&mut self, value : &'a dyn SevenZipProgressEvent); ... } ``` ## Remarks The on_progress event is automatically fired as compression or decompression is performed. When [WriteToProgressEvent](#WriteToProgressEvent) is true, the output data is provided through the *data* parameter, allowing for it to be streamed out. *file_name* contains the name of the file being written. If no file is being written, *file_name* will contain an empty string, and the output data will be provided exclusively through this event. *bytes_processed* contains the total number of uncompressed bytes processed. *percent_processed* contains the percent of uncompressed bytes processed, corresponding roughly to the running time of the operation. For **Gzip** extraction only, *bytes_processed* and *percent_processed* will reflect the number of compressed bytes extracted, as it is generally impossible to predetermine the total uncompressed size. If [WriteToProgressEvent](#WriteToProgressEvent) is false, *data* will contain null. # Config Settings ([SevenZip](#struct-ipworkszipsevenzip) 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](#config-method-sevenzip-struct) method. ### SevenZip Config Settings **BeginFileOnUpdate**: Enables or disables events firing when updating existing archives.This setting controls whether or not events will fire when calling [update](#update-method-sevenzip-struct). The default value is True. If set to False, [on_begin_file](#on_begin_file-event-sevenzip-struct) and [on_end_file](#on_end_file-event-sevenzip-struct) will not fire before and after updating a file in an existing archive. **CheckForFileLocks**: If true, the component requests an exclusive lock during initialization.If set to true, the component will request an exclusive lock during initialization to ensure there are no other processes locking a file. This is a temporary lock and is released before work is done. This is especially useful when another process has a partial lock on a file, for instance when Outlook is working with a .pst. False by default. **EnableFilter**: Enables or disables compression filters for executable files.When enabled, the struct will apply compression filters as appropriate during compression. Filters are applied to file executable file types: .dll, .exe, .ocx, .sfx, and .sys. Currently only the BCJ filter is used internally. The struct will automatically determine the files to which the filter is applied. The default value is True. **EnableHeaderCompression**: Enables or disables archive header compression.This setting controls whether or not header compression is used. When enabled some parts of the archive header will be compressed using the LZMA method. The default value is True. **EnableHeaderEncryption**: Enables or disables archive header encryption.This setting controls whether or not header encryption is used. The default value is False. When set to True the filenames in the resulting archive will be encrypted. **ExcludedAttributes**: Attributes of files to be excluded. Files with attributes matching those specified will be excluded from compression or decompression. May be set to any combination of *H* (hidden), *S* (system), *A* (archive), and *R* (read-only). (Example: "HSR") Alternatively, may be set to a bitmask of the following flags: Readonly (1), Hidden (2), System (4), Directory (16), Archive (32). For **Java**, when compressing, attributes other than "H" and "R" will be ignored (due to JRE limitations). *Default:* "" (no excluded attributes) **ExtractFilesOnly**: Whether to only extract the files contained within the archive. If true, only the files contained within the [archive_file](#archive_file-property-sevenzip-struct) are extracted directly to the specified [extract_to_path](#extract_to_path-property-sevenzip-struct). Folders contained within the [archive_file](#archive_file-property-sevenzip-struct) will not be created within the [extract_to_path](#extract_to_path-property-sevenzip-struct). If an archive contains files with the same name, you can control whether or not they get overwritten by setting [overwrite_files](#overwrite_files-property-sevenzip-struct). **FileNamesCaseSensitive**: This config controls the case-sensitivity of the struct when working with filenames.Set this to a value from below to control whether the struct is case-sensitive when working with filenames. | | | | --- | --- | | 0 | Case-Insensitive | | 1 | Case-Sensitive | | 2 | Automatic (Default) | The default behavior is *Automatic*. The struct will use the system behavior. **IsEncrypted**: Indicates whether the archive is encrypted.This setting indicates whether the archive is encrypted. This may be queried after calling [scan](#scan-method-sevenzip-struct). If the archive is encrypted [password](#password-property-sevenzip-struct) must be set before calling [extract](#extract-method-sevenzip-struct) or [extract_all](#extract_all-method-sevenzip-struct). **OverwriteReadonlyFiles**: Whether to overwrite readonly files. If true, the struct will overwrite readonly files when decompressing. If false (the default), the struct will fire the [on_error](#on_error-event-sevenzip-struct) event, instead, and will fail with an exception if the error is not trapped and explicitly ignored in the event. **TempPath**: A temporary directory where data can be stored during processing.If set, this setting specifies a location on disk where data may be temporarily stored during processing. This can be used to reduce memory consumption when processing large files. This will be used in situations where data must be held internally during the operation, for instance when editing an existing archive. The default value is empty string and data will not be written to disk. In most cases, using this setting will not be necessary. **WriteToProgressEvent**: Whether or not to write data to the Progress Event.If [WriteToProgressEvent](#WriteToProgressEvent) is set to true, then all data produced through invocations of [extract](#extract-method-sevenzip-struct), [extract_all](#extract_all-method-sevenzip-struct), and [compress](#compress-method-sevenzip-struct) will be written to the [on_progress](#on_progress-event-sevenzip-struct) event as well as to disk. Applications may stream out the compressed or decompressed data by trapping this event and copying the data. If [WriteToProgressEvent](#WriteToProgressEvent) is set to false, the data will not be streamed out, and the *Data* parameter of the [on_progress](#on_progress-event-sevenzip-struct) event will contain null. Note that if streaming is enabled the zip files written will be slightly larger. Moreover, zip files produced with [WriteToProgressEvent](#WriteToProgressEvent) may be incompatible with certain older zip utilities. By default, [password](#password-property-sevenzip-struct) encryption is not allowed for archives created with [WriteToProgressEvent](#WriteToProgressEvent) set to true. You may set the [EnableStreamingEncryption](#EnableStreamingEncryption) setting to allow this, but streamed and encrypted zip files may be incompatible with other utilities. By default, this config is set to false. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information: - Product: The product the license is for. - Product Key: The key the license was generated from. - License Source: Where the license was found (e.g., RuntimeLicense, License File). - License Type: The type of license installed (e.g., Royalty Free, Single Server). - Last Valid Build: The last valid build number for which the license will work. **MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the struct will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the struct to use the internal implementation instead of using the system security libraries. On Windows, this setting is set to *false* by default. On Linux/macOS, this setting is set to *true* by default. To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the [OpenSSL Notes](platforms.md) section. # Trappable Errors ([SevenZip](#struct-ipworkszipsevenzip) Struct) **Errors** The following errors may be generated by the struct. Note that frequently the error message will contain more specific information than what is listed here. Note that some non-fatal errors may be trapped and explicitly ignored in the [on_error](#on_error-event-sevenzip-struct) event. This will allow the struct to continue operation even in case of error. ### SevenZip Errors | | | | --- | --- | | 101 | The zip archive is of an invalid or unsupported format. | | 105 | The password is missing or incorrect. | | 106 | Encryption is not supported when streaming is enabled. | | 111 | Can't open file for read. | | 112 | Can't open file for write. | | 113 | Can't create directory. | | 114 | The file is too large. | | 115 | Can't create empty archive. | | 116 | The archive must be scanned prior to attempting this operation. | | 117 | The array index is out of range. | | 118 | The maximum size of the archive has been exceeded. | | 119 | The archive must be specified, or streaming must be enabled. | | 120 | The component is busy. | | 124 | Must specify the compressed name. | | 127 | Bad CRC-32 checksum. | | 128 | Unable to set file date. | | 133 | File already exists in the archive. | | 150 | An I/O error has occurred (details follow). |