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

//! The admission tickets that ride the actor's bounded queue. Rows never
//! cross this channel — only requests to admit a sort or report stats.

use tokio::sync::oneshot;

use crate::error::SorterError;
use crate::service::lease::SortLease;
use crate::service::stats::SorterStats;
use crate::spec::SortSpec;

/// A message to the Sorter actor.
pub(crate) enum SorterCommand {
    /// Admit a sort: plan it, reserve its resources, and return a lease.
    Submit {
        /// The sort's size description.
        spec: SortSpec,
        /// Where the admitted lease (or admission error) is delivered.
        reply: oneshot::Sender<Result<SortLease, SorterError>>,
    },
    /// Report the current governance counters.
    Stats {
        /// Where the stats snapshot is delivered.
        reply: oneshot::Sender<SorterStats>,
    },
}