sort-governor 0.1.3

Process-wide governor for bounded asynchronous sorting: plans in-memory versus external sorts and rations file descriptors and spill memory
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

//! Failures the sort governor and its execution engine can surface.

/// An error raised while admitting, spilling, reading, or merging a sort.
#[derive(Debug, thiserror::Error)]
pub enum SorterError {
    /// A spill file or scratch directory could not be created, written,
    /// read, or removed.
    #[error("sort I/O error: {0}")]
    Io(#[from] async_fs_io::FsError),
    /// A run row could not be encoded for spilling.
    #[error("sort row encode failed: {0}")]
    Encode(String),
    /// A run row could not be decoded from a spill file.
    #[error("sort row decode failed: {0}")]
    Decode(String),
    /// The session has exhausted its checked 64-bit spill counter.
    #[error("sort exceeds the maximum number of spill runs")]
    RunLimit,
    /// An earlier spill failed or was cancelled, invalidating this session.
    #[error("sort session cannot continue after a failed or cancelled spill")]
    SessionFailed,
    /// The governor actor is no longer running (its task ended or every
    /// handle was dropped), so the sort could not be admitted.
    #[error("sort governor is not running")]
    Gone,
}