Enum CompressionAlgorithm

Identifies the compression algorithm used for compress and decompress operations in ScyllaCompression and ICompressionProvider.

Namespace: Scylla.Core.Util.Compression
Assembly: ScyllaCore.dll
Syntax
public enum CompressionAlgorithm
Remarks

GZip and Deflate are always available because they are implemented using the built-in .NET System.IO.Compression namespace and require no additional packages.

Zip and BZip2 are only available when the com.unity.sharp-zip-lib package (version 1.4.1 or later) is installed and the SCYLLA_HAS_SHARPZIPLIB scripting define symbol is present. Passing these values on a build without the define results in a CompressionException with error code UnsupportedAlgorithm.

The active algorithm is configured through Algorithm or via the DefaultAlgorithm property, which is used when no explicit CompressionSettings is provided.

The Zip value is the only algorithm that supports multi-file archive operations through the IArchiveProvider interface, including folder compression, optional AES-256 password encryption, and individual entry extraction.

Fields

Name Description
BZip2

BZip2 compression. Produces files with the .bz2 extension.
Deflate

Raw Deflate compression conforming to RFC 1951. Produces files with the .deflate extension.
GZip

GZip compression conforming to RFC 1952. Produces files with the .gz extension.
Zip

ZIP archive format as defined by PKZip/APPNOTE.TXT. Produces files with the .zip extension.
See Also