Expand description
Welcome to the TFHE-rs API documentation!
TFHE-rs is a fully homomorphic encryption (FHE) library that implements Zama’s variant of TFHE.
Re-exports§
pub use error::Error;
pub use error::ErrorKind;
pub use crate::integer::oprf::SignedRandomizationSpec;
Modules§
- boolean
boolean
Welcome to the TFHE-rsboolean
module documentation! - Welcome to the TFHE-rs
core_crypto
module documentation! - integer
integer
Welcome to the TFHE-rsinteger
module documentation! - prelude
integer
The tfhe prelude. The purpose of this module is to make it easier to have the most commonly needed traits of this crate. - safe_serialize
integer
- shortint
shortint
Welcome to the TFHE-rsshortint
module documentation!
Structs§
- ClientKey
integer
Key of the client - CompactFheBool
integer
Compact FheBool - CompactFheBoolList
integer
Compact list of FheBool - CompactFheInt
integer
Compact FheInt - CompactFheIntList
integer
Compact list of FheInt - CompactFheUint
integer
Compact FheUint - CompactFheUintList
integer
Compact list of FheUint - CompactPublicKey
integer
A more compact public key - CompressedCompactPublicKey
integer
Compressed variant of CompactPublicKey - CompressedFheInt
integer
Compressed FheInt - CompressedFheUint
integer
Compressed FheUint - CompressedPublicKey
integer
Compressed classical public key. - CompressedServerKey
integer
Compressed ServerKey - Config
integer
The config type - ConfigBuilder
integer
The builder to create your config - CudaServerKey
integer
andgpu
- FheBool
integer
The FHE boolean data type. - FheBoolConformanceParams
integer
- FheInt
integer
A Generic FHE signed integer - FheInt2Id
integer
Id for the FheInt2 data type. - FheInt4Id
integer
Id for the FheInt4 data type. - FheInt6Id
integer
Id for the FheInt6 data type. - FheInt8Id
integer
Id for the FheInt8 data type. - FheInt10Id
integer
Id for the FheInt10 data type. - FheInt12Id
integer
Id for the FheInt12 data type. - FheInt14Id
integer
Id for the FheInt14 data type. - FheInt16Id
integer
Id for the FheInt16 data type. - FheInt32Id
integer
Id for the FheInt32 data type. - FheInt64Id
integer
Id for the FheInt64 data type. - FheInt128Id
integer
Id for the FheInt128 data type. - FheInt160Id
integer
Id for the FheInt160 data type. - FheInt256Id
integer
Id for the FheInt256 data type. - FheUint
integer
A Generic FHE unsigned integer - FheUint2Id
integer
Id for the FheUint2 data type. - FheUint4Id
integer
Id for the FheUint4 data type. - FheUint6Id
integer
Id for the FheUint6 data type. - FheUint8Id
integer
Id for the FheUint8 data type. - FheUint10Id
integer
Id for the FheUint10 data type. - FheUint12Id
integer
Id for the FheUint12 data type. - FheUint14Id
integer
Id for the FheUint14 data type. - FheUint16Id
integer
Id for the FheUint16 data type. - FheUint32Id
integer
Id for the FheUint32 data type. - FheUint64Id
integer
Id for the FheUint64 data type. - FheUint128Id
integer
Id for the FheUint128 data type. - FheUint160Id
integer
Id for the FheUint160 data type. - FheUint256Id
integer
Id for the FheUint256 data type. - KeySwitchingKey
integer
- PublicKey
integer
Classical public key. - A seed value, used to initialize a generator.
- ServerKey
integer
Key of the server
Enums§
- CompressedFheBool
integer
Compressed FheBool - Device
integer
Devices supported by tfhe-rs
Traits§
- IntegerId
integer
Trait to mark ID type for integers
Functions§
- generate_keys
integer
Generates keys using the provided config. - safe_serialize
integer
- set_server_key
integer
The function used to initialize internal keys. - unset_server_key
integer
- with_server_key_as_context
integer
Type Aliases§
- CompactFheInt2
integer
A compact signed integer type with 2 bits - CompactFheInt2List
integer
A compact list of signed integer type with 2 bits - CompactFheInt4
integer
A compact signed integer type with 4 bits - CompactFheInt4List
integer
A compact list of signed integer type with 4 bits - CompactFheInt6
integer
A compact signed integer type with 6 bits - CompactFheInt6List
integer
A compact list of signed integer type with 6 bits - CompactFheInt8
integer
A compact signed integer type with 8 bits - CompactFheInt8List
integer
A compact list of signed integer type with 8 bits - CompactFheInt10
integer
A compact signed integer type with 10 bits - CompactFheInt10List
integer
A compact list of signed integer type with 10 bits - CompactFheInt12
integer
A compact signed integer type with 12 bits - CompactFheInt12List
integer
A compact list of signed integer type with 12 bits - CompactFheInt14
integer
A compact signed integer type with 14 bits - CompactFheInt14List
integer
A compact list of signed integer type with 14 bits - CompactFheInt16
integer
A compact signed integer type with 16 bits - CompactFheInt16List
integer
A compact list of signed integer type with 16 bits - CompactFheInt32
integer
A compact signed integer type with 32 bits - CompactFheInt32List
integer
A compact list of signed integer type with 32 bits - CompactFheInt64
integer
A compact signed integer type with 64 bits - CompactFheInt64List
integer
A compact list of signed integer type with 64 bits - CompactFheInt128
integer
A compact signed integer type with 128 bits - CompactFheInt128List
integer
A compact list of signed integer type with 128 bits - CompactFheInt160
integer
A compact signed integer type with 160 bits - CompactFheInt160List
integer
A compact list of signed integer type with 160 bits - CompactFheInt256
integer
A compact signed integer type with 256 bits - CompactFheInt256List
integer
A compact list of signed integer type with 256 bits - CompactFheUint2
integer
- CompactFheUint2List
integer
- CompactFheUint4
integer
- CompactFheUint4List
integer
- CompactFheUint6
integer
- CompactFheUint6List
integer
- CompactFheUint8
integer
- CompactFheUint8List
integer
- CompactFheUint10
integer
- CompactFheUint10List
integer
- CompactFheUint12
integer
- CompactFheUint12List
integer
- CompactFheUint14
integer
- CompactFheUint14List
integer
- CompactFheUint16
integer
- CompactFheUint16List
integer
- CompactFheUint32
integer
- CompactFheUint32List
integer
- CompactFheUint64
integer
- CompactFheUint64List
integer
- CompactFheUint128
integer
- CompactFheUint128List
integer
- CompactFheUint160
integer
- CompactFheUint160List
integer
- CompactFheUint256
integer
- CompactFheUint256List
integer
- CompressedFheInt2
integer
A compressed signed integer type with 2 bits - CompressedFheInt4
integer
A compressed signed integer type with 4 bits - CompressedFheInt6
integer
A compressed signed integer type with 6 bits - CompressedFheInt8
integer
A compressed signed integer type with 8 bits - CompressedFheInt10
integer
A compressed signed integer type with 10 bits - CompressedFheInt12
integer
A compressed signed integer type with 12 bits - CompressedFheInt14
integer
A compressed signed integer type with 14 bits - CompressedFheInt16
integer
A compressed signed integer type with 16 bits - CompressedFheInt32
integer
A compressed signed integer type with 32 bits - CompressedFheInt64
integer
A compressed signed integer type with 64 bits - CompressedFheInt128
integer
A compressed signed integer type with 128 bits - CompressedFheInt160
integer
A compressed signed integer type with 160 bits - CompressedFheInt256
integer
A compressed signed integer type with 256 bits - CompressedFheUint2
integer
- CompressedFheUint4
integer
- CompressedFheUint6
integer
- CompressedFheUint8
integer
- CompressedFheUint10
integer
- CompressedFheUint12
integer
- CompressedFheUint14
integer
- CompressedFheUint16
integer
- CompressedFheUint32
integer
- CompressedFheUint64
integer
- CompressedFheUint128
integer
- CompressedFheUint160
integer
- CompressedFheUint256
integer
- FheInt2
integer
A signed integer type with 2 bits - FheInt2ConformanceParams
integer
- FheInt4
integer
A signed integer type with 4 bits - FheInt4ConformanceParams
integer
- FheInt6
integer
A signed integer type with 6 bits - FheInt6ConformanceParams
integer
- FheInt8
integer
A signed integer type with 8 bits - FheInt8ConformanceParams
integer
- FheInt10
integer
A signed integer type with 10 bits - FheInt10ConformanceParams
integer
- FheInt12
integer
A signed integer type with 12 bits - FheInt12ConformanceParams
integer
- FheInt14
integer
A signed integer type with 14 bits - FheInt14ConformanceParams
integer
- FheInt16
integer
A signed integer type with 16 bits - FheInt16ConformanceParams
integer
- FheInt32
integer
A signed integer type with 32 bits - FheInt32ConformanceParams
integer
- FheInt64
integer
A signed integer type with 64 bits - FheInt64ConformanceParams
integer
- FheInt128
integer
A signed integer type with 128 bits - FheInt128ConformanceParams
integer
- FheInt160
integer
A signed integer type with 160 bits - FheInt160ConformanceParams
integer
- FheInt256
integer
A signed integer type with 256 bits - FheInt256ConformanceParams
integer
- FheUint2
integer
An unsigned integer type with 2 bits - FheUint2ConformanceParams
integer
- FheUint4
integer
An unsigned integer type with 4 bits - FheUint4ConformanceParams
integer
- FheUint6
integer
An unsigned integer type with 6 bits - FheUint6ConformanceParams
integer
- FheUint8
integer
An unsigned integer type with 8 bits - FheUint8ConformanceParams
integer
- FheUint10
integer
An unsigned integer type with 10 bits - FheUint10ConformanceParams
integer
- FheUint12
integer
An unsigned integer type with 12 bits - FheUint12ConformanceParams
integer
- FheUint14
integer
An unsigned integer type with 14 bits - FheUint14ConformanceParams
integer
- FheUint16
integer
An unsigned integer type with 16 bits - FheUint16ConformanceParams
integer
- FheUint32
integer
An unsigned integer type with 32 bits - FheUint32ConformanceParams
integer
- FheUint64
integer
An unsigned integer type with 64 bits - FheUint64ConformanceParams
integer
- FheUint128
integer
An unsigned integer type with 128 bits - FheUint128ConformanceParams
integer
- FheUint160
integer
An unsigned integer type with 160 bits - FheUint160ConformanceParams
integer
- FheUint256
integer
An unsigned integer type with 256 bits - FheUint256ConformanceParams
integer