brk_core 0.0.83

The Core (Structs and Errors) of the Bitcoin Research Kit
Documentation
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, YearIndex};

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

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

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

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

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

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

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

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

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

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

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

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

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

impl From<Date> for DecadeIndex {
    fn from(value: Date) -> Self {
        let year = value.year();
        if year < 2000 {
            panic!("unsupported")
        }
        Self(((year - 2000) / 10) as u8)
    }
}

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

impl From<YearIndex> for DecadeIndex {
    fn from(value: YearIndex) -> Self {
        let v = usize::from(value);
        if v == 0 {
            Self(0)
        } else {
            Self((((v - 1) / 10) + 1) as u8)
        }
    }
}

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

    fn to_possible_strings() -> &'static [&'static str] {
        &["decade", "decadeindex"]
    }
}