xet-runtime 1.5.2

Async runtime, configuration, logging, and utility infrastructure for the Hugging Face Xet client tools.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

use thiserror::Error;

#[derive(Debug, Error)]
#[non_exhaustive]
pub enum RuntimeError {
    #[error("Error initializing runtime: {0:?}")]
    RuntimeInit(std::io::Error),

    #[error("Invalid runtime: {0}")]
    InvalidRuntime(String),

    #[error("A XetRuntime is already attached to this tokio runtime handle with Id {0}")]
    ExternalAlreadyAttached(tokio::runtime::Id),

    #[error("Task panic: {0:?}")]
    TaskPanic(String),

    #[error("Task cancelled; possible runtime shutdown in progress ({0}).")]
    TaskCanceled(String),

    #[error("Reqwest error: {0}")]
    ReqwestError(#[from] reqwest::Error),

    #[error("Lock poisoned: {0}")]
    LockPoisoned(String),

    #[error("Keyboard interrupt (SIGINT)")]
    KeyboardInterrupt,

    #[error("{0}")]
    Other(String),
}

// PoisonError<T> is generic over the lock-guard type, so #[from] cannot be used directly.
// This blanket impl gives the same `?`-propagation ergonomics for any poisoned std lock.
impl<T> From<std::sync::PoisonError<T>> for RuntimeError {
    fn from(e: std::sync::PoisonError<T>) -> Self {
        RuntimeError::LockPoisoned(e.to_string())
    }
}

impl From<tokio::task::JoinError> for RuntimeError {
    fn from(err: tokio::task::JoinError) -> Self {
        if err.is_panic() {
            tracing::error!("Panic reported on xet worker task: {err:?}");
            RuntimeError::TaskPanic(format!("{err:?}"))
        } else if err.is_cancelled() {
            RuntimeError::TaskCanceled(format!("{err}"))
        } else {
            RuntimeError::Other(format!("task join error: {err}"))
        }
    }
}

pub type Result<T> = std::result::Result<T, RuntimeError>;