Enum FileErrorCode

Specifies structured error codes that classify the reason a file I/O operation failed.

Namespace: Scylla.Core.Util.File

Assembly: ScyllaCore.dll

Syntax

public enum FileErrorCode

Remarks

Every FileException carries a FileErrorCode value so callers can branch on the specific failure category without parsing exception messages. Use this enum in catch (FileException ex) blocks to determine the appropriate recovery strategy.

Codes are grouped by concern:

Path validity: NullData, InvalidPath, PathTooLong
File existence: FileNotFound, DirectoryNotFound, FileExists
Access and locking: AccessDenied, FileLocked
Operational: IOError, InsufficientSpace, Timeout, OperationCancelled
Image-specific: UnsupportedImageFormat, TextureNotReadable, ImageEncodingFailed, ImageDecodingFailed
Data pipeline: UnsupportedEncoding, SerializationFailed, CompressionFailed, EncryptionFailed

Fields

Name	Description
AccessDenied	The calling process does not have permission to access the file or directory. On Windows this corresponds to `ERROR_ACCESS_DENIED`; on POSIX it corresponds to `EACCES`. Maps to UnauthorizedAccessException when wrapping a .NET exception.
CompressionFailed	The `ScyllaCompression` pipeline failed to compress or decompress the data. This may indicate corrupt compressed data, a missing codec, or insufficient memory.
DirectoryNotFound	One or more directories in the specified path do not exist and CreateDirectories is `false`. Maps to DirectoryNotFoundException when wrapping a .NET exception.
EncryptionFailed	The `ScyllaCrypto` pipeline failed to encrypt or decrypt the data. This may indicate an incorrect key, a corrupt cipher-text, or an authentication tag mismatch for AEAD modes such as AES-GCM or ChaCha20-Poly1305.
FileExists	The destination file already exists and OverwriteExisting is `false`. No data was written. Enable OverwriteExisting or delete the file first to allow the operation to proceed.
FileLocked	The file is currently held open by another process or thread in an incompatible share mode. On Windows this corresponds to `ERROR_SHARING_VIOLATION` (HResult `-2147024864`). Callers may retry after a short delay.
FileNotFound	The specified file path does not refer to an existing file. Maps to FileNotFoundException when wrapping a .NET exception.
IOError	A low-level I/O error occurred that does not map to a more specific code. The InnerException typically contains a IOException with additional platform-specific details.
ImageDecodingFailed	The image decoding step failed. This typically means the file data is corrupt, truncated, or in a format that cannot be decoded by the current Unity codec.
ImageEncodingFailed	The image encoding step failed. This may indicate an out-of-memory condition, an unsupported pixel format, or a codec error in the Unity encoder.
InsufficientSpace	The target drive or volume does not have enough free space to complete the write or copy operation.
InvalidPath	The path string contains characters that are illegal on the current platform, contains a `..` traversal sequence that escapes the expected directory, or is otherwise malformed. Maps to ArgumentException when wrapping a .NET exception.
InvalidSettings	One or more values in the supplied FileSettings are outside their valid range (for example, BufferSize below MIN_BUFFER_SIZE or a `null` encoding).
NullData	A required data argument or path was `null` or empty. This code is raised by validation helpers before any I/O is attempted, so no file system state has changed.
OperationCancelled	The operation was cancelled via the caller's CancellationToken before it completed. Maps to OperationCanceledException when wrapping a .NET exception.
PathTooLong	The full path string exceeds the maximum length allowed by the operating system (260 characters on Windows without long-path support; unlimited on POSIX). Maps to PathTooLongException when wrapping a .NET exception.
SerializationFailed	The `ScyllaSerialization` pipeline failed to serialize an object to bytes or deserialize bytes back to an object. Inspect InnerException for details from the serializer.
TextureNotReadable	The `UnityEngine.Texture2D` passed to an image-save operation is not marked as readable in the Unity import settings. Enable Read/Write in the texture's Import Settings to resolve this.
Timeout	The operation did not complete within the allotted time. Callers may retry with a longer timeout or a smaller transfer size.
Unknown	An unknown or unspecified error occurred. Used as a fallback when no more specific code applies. Inspect InnerException for the underlying cause.
UnsupportedEncoding	The requested text encoding is not supported or available on the current platform. Ensure the Encoding property is set to a valid, non-null Encoding instance.
UnsupportedImageFormat	The file's format or extension is not among those supported by the image I/O subsystem. Supported formats are defined by `ImageFileFormat`.