tfhe 1.6.1

TFHE-rs is a fully homomorphic encryption (FHE) library that implements Zama's variant of TFHE.
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

use std::fmt::{Debug, Display, Formatter};

#[derive(Debug, Clone, Eq, PartialEq)]
pub enum ErrorKind {
    Message(String),
    /// The provided range for a slicing operation was invalid
    InvalidRange(InvalidRangeError),
    /// The zero knowledge proof and the content it is supposed to prove
    /// failed to correctly prove
    #[cfg(feature = "zk-pok")]
    InvalidZkProof,
}

#[derive(Debug, Clone)]
pub struct Error {
    kind: ErrorKind,
}

impl Error {
    pub(crate) fn new(message: String) -> Self {
        Self::from(ErrorKind::Message(message))
    }

    pub fn kind(&self) -> &ErrorKind {
        &self.kind
    }
}

#[cfg(feature = "shortint")]
macro_rules! error{
    ($($arg:tt)*) => {
        $crate::error::Error::new(::std::format!($($arg)*))
    }
}

#[cfg(feature = "shortint")]
pub(crate) use error;

impl Display for Error {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self.kind() {
            ErrorKind::Message(msg) => {
                write!(f, "{msg}")
            }
            #[cfg(feature = "zk-pok")]
            ErrorKind::InvalidZkProof => {
                write!(f, "The zero knowledge proof and the content it is supposed to prove were not valid")
            }
            ErrorKind::InvalidRange(err) => write!(f, "Invalid range: {err}"),
        }
    }
}

impl From<ErrorKind> for Error {
    fn from(kind: ErrorKind) -> Self {
        Self { kind }
    }
}

impl<'a> From<&'a str> for Error {
    fn from(message: &'a str) -> Self {
        Self::new(message.to_string())
    }
}

impl From<String> for Error {
    fn from(message: String) -> Self {
        Self::new(message)
    }
}

impl From<InvalidRangeError> for Error {
    fn from(value: InvalidRangeError) -> Self {
        let kind = ErrorKind::InvalidRange(value);
        Self { kind }
    }
}

impl std::error::Error for Error {}

// This is useful to use infallible conversions as well as fallible ones in certain parts of the lib
impl From<std::convert::Infallible> for Error {
    fn from(_value: std::convert::Infallible) -> Self {
        // This can never be reached
        unreachable!()
    }
}

/// Error returned when the provided range for a slice is invalid
#[derive(Debug, Clone, Eq, PartialEq)]
pub enum InvalidRangeError {
    /// The upper bound of the range is greater than the size of the integer
    SliceTooBig,
    /// The upper bound is smaller than the lower bound
    WrongOrder,
}

impl Display for InvalidRangeError {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::SliceTooBig => write!(
                f,
                "The upper bound of the range is greater than the size of the integer"
            ),
            Self::WrongOrder => {
                write!(f, "The upper bound is smaller than the lower bound")
            }
        }
    }
}

impl std::error::Error for InvalidRangeError {}