brk_types 0.3.0-alpha.6

Structs used throughout BRK
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

use std::fmt;

use derive_more::Deref;
use schemars::JsonSchema;
use serde::Deserialize;

/// Maximum number of results to return. Defaults to 100 if not specified.
#[derive(Debug, Clone, Copy, Deref, Deserialize, JsonSchema)]
#[serde(transparent)]
#[allow(clippy::duplicated_attributes)]
#[schemars(default, example = 1, example = 10, example = 100)]
pub struct Limit(usize);

impl Limit {
    pub const MIN: Self = Self(1);
    pub const DEFAULT: Self = Self(100);

    pub fn is_zero(&self) -> bool {
        self.0 == 0
    }
}

impl Default for Limit {
    fn default() -> Self {
        Self::DEFAULT
    }
}

impl fmt::Display for Limit {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl From<usize> for Limit {
    fn from(value: usize) -> Self {
        Self(value)
    }
}