iota-crypto 0.23.2

The canonical source of cryptographic ground-truth for all IOTA Rust projects
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

// Copyright 2020-2021 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

/// Balanced trits.
pub mod balanced;
/// Unbalanced trits.
pub mod unbalanced;

use core::{convert::TryFrom, fmt, hash};

use num_traits::{CheckedAdd, CheckedSub, Num};

// Reexports
pub use self::{balanced::Btrit, unbalanced::Utrit};
use crate::encoding::ternary::convert;

/// A trait implemented by both balanced ([`Btrit`]) and unbalanced ([`Utrit`]) trits.
pub trait Trit:
    Copy + Sized + fmt::Debug + hash::Hash + Into<i8> + Ord + PartialEq + ShiftTernary + TryFrom<i8> + fmt::Display
{
    /// Attempt to increment the value of this trit, returning [`None`] if an overflow occurred.
    fn checked_increment(self) -> Option<Self>;

    /// The zero value of this trit.
    fn zero() -> Self;

    /// Turn this trit reference into one with an arbitrary lifetime.
    ///
    /// Note that this is largely an implementation detail and is rarely useful for API users.
    fn as_arbitrary_ref<'a>(&self) -> &'a Self;

    /// Attempt to add this trit to a numeric value.
    fn add_to_num<I: Num + CheckedAdd + CheckedSub>(&self, n: I) -> Result<I, convert::Error>;
}

/// A trait implemented by trits that can be shifted between balance domains.
// TODO: Is this a good API?
pub trait ShiftTernary: Sized {
    /// The trit type that results from shifting this trit.
    type Target: ShiftTernary<Target = Self>;

    /// Shift this trit into the opposite balance domain.
    fn shift(self) -> Self::Target;
}