brk_types 0.3.0-beta.8

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

use std::{borrow::Cow, fmt::Display};

use derive_more::Deref;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

/// Series name
#[derive(Debug, Clone, Deref, Serialize, Deserialize, JsonSchema)]
#[serde(transparent)]
#[schemars(
    with = "String",
    example = &"price_close",
    example = &"market_cap",
    example = &"realized_price"
)]
pub struct SeriesName(String);

impl SeriesName {
    /// Lookup key: `-` → `_`, lowercased. Borrows when already normalized.
    pub fn normalize(&self) -> Cow<'_, str> {
        if self.0.bytes().any(|b| b == b'-' || b.is_ascii_uppercase()) {
            Cow::Owned(self.0.replace('-', "_").to_lowercase())
        } else {
            Cow::Borrowed(&self.0)
        }
    }
}

impl From<String> for SeriesName {
    #[inline]
    fn from(series: String) -> Self {
        Self(series)
    }
}

impl From<&str> for SeriesName {
    #[inline]
    fn from(series: &str) -> Self {
        Self(series.to_owned())
    }
}

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