modicum 0.1.0

Modular arithemtic library in pure Rust
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

use num_traits::Unsigned;

use crate::Integer;

/// Modulus is an unsigned integer that can be cast to some other type `T`.
/// The purpose is to restrict the modulus to unsigned integers yet allow calculations with signed integers
/// when necessary.
pub trait Modulus<T>: Integer + Unsigned
where
    T: TryFrom<Self>,
    <T as TryFrom<Self>>::Error: std::fmt::Debug,
{
    /// Cast the modulus to some other type `T`.
    /// Panics if the modulus cannot be converted to `T`.
    fn cast(self) -> T {
        self.try_into().expect("cannot convert modulus")
    }
}

impl<T, M> Modulus<T> for M
where
    T: TryFrom<M>,
    <T as TryFrom<M>>::Error: std::fmt::Debug,
    M: Integer + Unsigned,
{
}