brk_core 0.0.83

The Core (Structs and Errors) of the Bitcoin Research Kit
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116

use std::{
    fmt::Debug,
    ops::{Add, AddAssign, Div},
};

use serde::{Deserialize, Serialize};
use zerocopy_derive::{FromBytes, Immutable, IntoBytes, KnownLayout};

use crate::{CheckedSub, Printable};

use super::{Date, DateIndex, MonthIndex};

#[derive(
    Debug,
    Clone,
    Copy,
    PartialEq,
    Eq,
    PartialOrd,
    Ord,
    Default,
    Serialize,
    Deserialize,
    FromBytes,
    Immutable,
    IntoBytes,
    KnownLayout,
)]
pub struct YearIndex(u8);

impl From<u8> for YearIndex {
    fn from(value: u8) -> Self {
        Self(value)
    }
}

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

impl From<YearIndex> for usize {
    fn from(value: YearIndex) -> Self {
        value.0 as usize
    }
}

impl Add<usize> for YearIndex {
    type Output = Self;

    fn add(self, rhs: usize) -> Self::Output {
        Self::from(self.0 + rhs as u8)
    }
}

impl Add<YearIndex> for YearIndex {
    type Output = Self;

    fn add(self, rhs: Self) -> Self::Output {
        Self::from(self.0 + rhs.0)
    }
}

impl AddAssign for YearIndex {
    fn add_assign(&mut self, rhs: Self) {
        *self = Self(self.0 + rhs.0)
    }
}

impl Div<usize> for YearIndex {
    type Output = Self;
    fn div(self, _: usize) -> Self::Output {
        unreachable!()
    }
}

impl From<DateIndex> for YearIndex {
    fn from(value: DateIndex) -> Self {
        Self::from(Date::from(value))
    }
}

impl From<Date> for YearIndex {
    fn from(value: Date) -> Self {
        Self((value.year() - 2009) as u8)
    }
}

impl From<YearIndex> for u16 {
    fn from(value: YearIndex) -> Self {
        value.0 as u16
    }
}

impl CheckedSub for YearIndex {
    fn checked_sub(self, rhs: Self) -> Option<Self> {
        self.0.checked_sub(rhs.0).map(Self)
    }
}

impl From<MonthIndex> for YearIndex {
    fn from(value: MonthIndex) -> Self {
        Self((usize::from(value) / 12) as u8)
    }
}

impl Printable for YearIndex {
    fn to_string() -> &'static str {
        "yearindex"
    }

    fn to_possible_strings() -> &'static [&'static str] {
        &["y", "year", "yearindex"]
    }
}