brk_types 0.3.0-alpha.6

Structs used throughout BRK
Documentation
use std::ops::{Add, AddAssign};

use byteview::ByteView;
use derive_more::{Deref, DerefMut};
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};
use vecdb::{CheckedSub, Formattable, Pco, PrintableIndex};

use super::StoredU32;

#[derive(
    Debug,
    PartialEq,
    Eq,
    PartialOrd,
    Ord,
    Clone,
    Copy,
    Deref,
    DerefMut,
    Default,
    Serialize,
    Deserialize,
    Pco,
    JsonSchema,
    Hash,
)]
pub struct TxIndex(u32);

impl TxIndex {
    pub const ZERO: Self = Self(0);
    pub const COINBASE: Self = Self(u32::MAX);

    pub fn new(tx_index: u32) -> Self {
        Self(tx_index)
    }

    pub fn incremented(self) -> Self {
        Self(*self + 1)
    }

    pub fn to_be_bytes(&self) -> [u8; 4] {
        self.0.to_be_bytes()
    }

    pub fn to_ne_bytes(&self) -> [u8; 4] {
        self.0.to_ne_bytes()
    }

    #[inline(always)]
    pub fn is_coinbase(self) -> bool {
        self == Self::COINBASE
    }

    #[inline(always)]
    pub fn is_not_coinbase(self) -> bool {
        self != Self::COINBASE
    }
}

impl Add<TxIndex> for TxIndex {
    type Output = Self;
    fn add(self, rhs: TxIndex) -> Self::Output {
        Self(self.0 + rhs.0)
    }
}

impl Add<usize> for TxIndex {
    type Output = Self;
    fn add(self, rhs: usize) -> Self::Output {
        Self(self.0 + rhs as u32)
    }
}

impl AddAssign<TxIndex> for TxIndex {
    fn add_assign(&mut self, rhs: TxIndex) {
        self.0 += rhs.0
    }
}

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

impl From<u32> for TxIndex {
    #[inline]
    fn from(value: u32) -> Self {
        Self(value)
    }
}

impl From<TxIndex> for u32 {
    #[inline]
    fn from(value: TxIndex) -> Self {
        value.0
    }
}

impl From<u64> for TxIndex {
    #[inline]
    fn from(value: u64) -> Self {
        Self(value as u32)
    }
}
impl From<TxIndex> for u64 {
    #[inline]
    fn from(value: TxIndex) -> Self {
        value.0 as u64
    }
}

impl From<usize> for TxIndex {
    #[inline]
    fn from(value: usize) -> Self {
        Self(value as u32)
    }
}
impl From<TxIndex> for usize {
    #[inline]
    fn from(value: TxIndex) -> Self {
        value.0 as usize
    }
}

impl From<ByteView> for TxIndex {
    #[inline(always)]
    fn from(value: ByteView) -> Self {
        Self(u32::from_be_bytes((&*value).try_into().unwrap()))
    }
}
impl From<TxIndex> for ByteView {
    #[inline(always)]
    fn from(value: TxIndex) -> Self {
        ByteView::from(&value)
    }
}
impl From<&TxIndex> for ByteView {
    #[inline(always)]
    fn from(value: &TxIndex) -> Self {
        Self::new(&value.to_be_bytes())
    }
}

impl From<TxIndex> for StoredU32 {
    #[inline]
    fn from(value: TxIndex) -> Self {
        Self::from(value.0)
    }
}

impl PrintableIndex for TxIndex {
    fn to_string() -> &'static str {
        "tx_index"
    }

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

impl std::fmt::Display for TxIndex {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        let mut buf = itoa::Buffer::new();
        let str = buf.format(self.0);
        f.write_str(str)
    }
}

impl Formattable for TxIndex {
    #[inline(always)]
    fn write_to(&self, buf: &mut Vec<u8>) {
        let mut b = itoa::Buffer::new();
        buf.extend_from_slice(b.format(self.0).as_bytes());
    }
}