Enum XetError 

#[non_exhaustive]
pub enum XetError {
    KeyboardInterrupt,
    UserCancelled(String),
    PreviousTaskError(String),
    TaskError(String),
    AlreadyCompleted,
    InvalidTaskID(UniqueID),
    Authentication(String),
    Network(String),
    Timeout(String),
    NotFound(String),
    DataIntegrity(String),
    Configuration(String),
    Io(String),
    Cancelled(String),
    Internal(String),
    WrongRuntimeMode(String),
}

Unified error type for the Xet public API.

Variants are grouped into user-facing categories that map naturally to Python exception types, plus session-lifecycle states that the internal code can match on.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

KeyboardInterrupt

SIGINT / runtime shutdown.

UserCancelled(String)

Explicit user abort (session, commit, group, or stream level).

PreviousTaskError(String)

A previous operation on this task failed; carries the stored error description.

TaskError(String)

Task-level error captured from a background upload/download handle.

AlreadyCompleted

The operation has already completed, is already finalizing, or was already committed/finished.

InvalidTaskID(UniqueID)

A task ID that doesn’t correspond to any queued file.

Authentication(String)

Token refresh or credential failures.

Network(String)

Network-level failures: DNS, HTTP 5xx, connection reset, etc.

Timeout(String)

A network request timed out.

NotFound(String)

A requested resource (file, XORB, shard) does not exist.

DataIntegrity(String)

Data corruption: hash mismatches, invalid shard/xorb format, etc.

Configuration(String)

Invalid configuration or arguments supplied by the caller.

Io(String)

Local filesystem I/O failures.

Cancelled(String)

Generic cancellation from non-user sources (semaphore close, join cancellation).

Internal(String)

Catch-all for unexpected internal errors (panics, lock poison, bugs).

WrongRuntimeMode(String)

Caller invoked a method that is incompatible with the session’s runtime mode.

Implementations

impl XetError

pub fn other(msg: impl Display) -> Self

pub fn wrong_mode(msg: impl Display) -> Self

Trait Implementations

impl Debug for XetError

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for XetError

fn fmt(&self, __formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Error for XetError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<AcquireError> for XetError

fn from(e: AcquireError) -> Self

Converts to this type from the input type.

impl From<ClientError> for XetError

fn from(e: ClientError) -> Self

Converts to this type from the input type.

impl From<CoreError> for XetError

fn from(e: CoreError) -> Self

Converts to this type from the input type.

impl From<DataError> for XetError

fn from(e: DataError) -> Self

Converts to this type from the input type.

impl From<Error> for XetError

fn from(e: Error) -> Self

Converts to this type from the input type.

impl From<FileReconstructionError> for XetError

fn from(e: FileReconstructionError) -> Self

Converts to this type from the input type.

impl From<JoinError> for XetError

fn from(e: JoinError) -> Self

Converts to this type from the input type.

impl<T> From<PoisonError<MutexGuard<'_, T>>> for XetError

fn from(e: PoisonError<MutexGuard<'_, T>>) -> Self

Converts to this type from the input type.

impl<T> From<PoisonError<RwLockReadGuard<'_, T>>> for XetError

fn from(e: PoisonError<RwLockReadGuard<'_, T>>) -> Self

Converts to this type from the input type.

impl<T> From<PoisonError<RwLockWriteGuard<'_, T>>> for XetError

fn from(e: PoisonError<RwLockWriteGuard<'_, T>>) -> Self

Converts to this type from the input type.

impl From<RuntimeError> for XetError

fn from(e: RuntimeError) -> Self

Converts to this type from the input type.