Enum CompressionErrorCode

Categorizes the failure reason reported by a CompressionException or a failed CompressionResult / CompressionResult<T>.

Namespace: Scylla.Core.Util.Compression

Assembly: ScyllaCore.dll

Syntax

public enum CompressionErrorCode

Remarks

When ScyllaCompression methods throw or return a failure, they always supply one of these codes. Callers can inspect the code to decide whether to retry, surface an error to the user, or take a recovery action such as prompting for a password (WrongPassword) or freeing disk space (InsufficientSpace).

On successful results, ErrorCode is set to Unknown as a neutral sentinel - inspect IsSuccess first before reading the error code.

Fields

Name	Description
AccessDenied	The running process lacks the OS permission required to read the source file or write the destination. Verify path permissions or run with elevated privileges.
CorruptedData	The compressed byte stream is corrupted, truncated, or uses an unrecognized format. This typically results from a modified or partially-transferred archive, or from attempting to decompress with the wrong algorithm.
DecompressedSizeExceeded	Decompression was aborted because the output grew past MaxDecompressedSize. The input expands to more data than the in-memory decompression ceiling allows, either because it is a decompression bomb (crafted input whose decompressed size dwarfs the bytes received) or because it is legitimately larger than the configured ceiling.
EntryNotFound	An ExtractEntry(string, string) or ExtractEntryToFile(string, string, string, CompressionSettings) call referenced a path that does not exist in the archive. Use ListEntries(string) to obtain the available paths before extracting.
FileExists	A file at the destination path already exists and OverwriteExisting is `false`. Enable overwrite in settings or delete the existing file before extracting.
FileNotFound	A source file or directory path does not exist. Verify that the path is correct and accessible before calling archive operations on it.
IOError	A general I/O error occurred during a file-based compression or extraction operation. Inspect the `CompressionException.InnerException` for the underlying `IOException` details.
InsufficientSpace	The target disk or volume does not have enough free space to complete the operation. Free disk space and retry, or choose a destination on a volume with more available capacity.
InvalidPassword	An encrypted archive operation requires a password but Password is `null` or empty. Set the password in settings before creating or extracting encrypted archives.
InvalidSettings	One or more values in the supplied CompressionSettings failed validation (e.g., BufferSize outside the allowed range, or MaxDegreeOfParallelism less than one). Call Validate() to surface the specific constraint that was violated before calling compression methods.
NullData	A required parameter (data array or stream) was `null`. Callers should ensure that all data arguments passed to ScyllaCompression methods are non-null before calling.
OperationCancelled	The operation was cancelled by the caller via a `CancellationToken` before it could complete. Partial output produced before cancellation is discarded.
Unknown	An unknown or unspecified error occurred that does not map to any other code. Also used as the neutral sentinel value on successful CompressionResult instances - always check IsSuccess before using the error code.
UnsupportedAlgorithm	The requested CompressionAlgorithm value requires an optional package (e.g., `com.unity.sharp-zip-lib`) that is not installed in this build. Check IsSupported before using algorithm-specific providers directly.
WrongPassword	The password supplied in Password does not match the one used to encrypt the archive. Prompt the user for the correct password and retry.