brk_types 0.2.2

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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

use schemars::JsonSchema;
use serde::Deserialize;

use crate::{Limit, RangeIndex, de_unquote_limit};

/// Range parameters for slicing data
#[derive(Default, Debug, Deserialize, JsonSchema)]
pub struct DataRange {
    /// Inclusive start: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `from`, `f`, `s`
    #[serde(default, alias = "s", alias = "from", alias = "f")]
    start: Option<RangeIndex>,

    /// Exclusive end: integer index, date (YYYY-MM-DD), or timestamp (ISO 8601). Negative integers count from end. Aliases: `to`, `t`, `e`
    #[serde(default, alias = "e", alias = "to", alias = "t")]
    end: Option<RangeIndex>,

    /// Maximum number of values to return (ignored if `end` is set). Aliases: `count`, `c`, `l`
    #[serde(
        default,
        alias = "l",
        alias = "count",
        alias = "c",
        deserialize_with = "de_unquote_limit"
    )]
    limit: Option<Limit>,
}

impl DataRange {
    pub fn set_start(mut self, start: i64) -> Self {
        self.start.replace(RangeIndex::Int(start));
        self
    }

    pub fn set_end(mut self, end: i64) -> Self {
        self.end.replace(RangeIndex::Int(end));
        self
    }

    pub fn set_limit(mut self, limit: Limit) -> Self {
        self.limit.replace(limit);
        self
    }

    pub fn start(&self) -> Option<RangeIndex> {
        self.start
    }

    pub fn end(&self) -> Option<RangeIndex> {
        self.end
    }

    pub fn limit(&self) -> Option<Limit> {
        self.limit
    }
}