dinah 0.1.0

Rust-first modular runtime and high-performance compute foundation
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

use super::CoreError;
use core::fmt;

/// Validated limits for foundational dinah subsystems.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct CoreConfig {
    max_workers: usize,
    max_batch_size: usize,
}

/// Configuration validation failure, with the field that failed.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CoreConfigError {
    /// Worker count must be at least one.
    ZeroWorkers,
    /// Batch size must be at least one.
    ZeroBatchSize,
}

impl CoreConfig {
    /// Creates configuration after validating all limits.
    pub const fn new(max_workers: usize, max_batch_size: usize) -> Result<Self, CoreConfigError> {
        if max_workers == 0 {
            return Err(CoreConfigError::ZeroWorkers);
        }
        if max_batch_size == 0 {
            return Err(CoreConfigError::ZeroBatchSize);
        }
        Ok(Self {
            max_workers,
            max_batch_size,
        })
    }

    /// Returns a conservative configuration suitable for a single worker.
    pub const fn default_config() -> Self {
        Self {
            max_workers: 1,
            max_batch_size: 64,
        }
    }

    /// Returns the maximum number of workers allowed by this configuration.
    pub const fn max_workers(self) -> usize {
        self.max_workers
    }
    /// Returns the maximum number of items allowed in one batch.
    pub const fn max_batch_size(self) -> usize {
        self.max_batch_size
    }

    /// Checks whether this configuration satisfies Core's invariants.
    pub const fn validate(self) -> Result<(), CoreConfigError> {
        if self.max_workers == 0 {
            return Err(CoreConfigError::ZeroWorkers);
        }
        if self.max_batch_size == 0 {
            return Err(CoreConfigError::ZeroBatchSize);
        }
        Ok(())
    }
}

impl Default for CoreConfig {
    fn default() -> Self {
        Self::default_config()
    }
}

impl fmt::Display for CoreConfigError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::ZeroWorkers => f.write_str("max_workers must be greater than zero"),
            Self::ZeroBatchSize => f.write_str("max_batch_size must be greater than zero"),
        }
    }
}

impl std::error::Error for CoreConfigError {}

impl From<CoreConfigError> for CoreError {
    fn from(_: CoreConfigError) -> Self {
        Self::InvalidConfiguration
    }
}