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
booleanWelcome to the TFHE-rsbooleanmodule documentation! - Welcome to the TFHE-rs
core_cryptomodule documentation! - integer
integerWelcome to the TFHE-rsintegermodule documentation! - prelude
integerThe 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
shortintWelcome to the TFHE-rsshortintmodule documentation!
Structs§
- ClientKey
integerKey of the client - CompactFheBool
integerCompact FheBool - CompactFheBoolList
integerCompact list of FheBool - CompactFheInt
integerCompact FheInt - CompactFheIntList
integerCompact list of FheInt - CompactFheUint
integerCompact FheUint - CompactFheUintList
integerCompact list of FheUint - CompactPublicKey
integerA more compact public key - CompressedCompactPublicKey
integerCompressed variant of CompactPublicKey - CompressedFheInt
integerCompressed FheInt - CompressedFheUint
integerCompressed FheUint - CompressedPublicKey
integerCompressed classical public key. - CompressedServerKey
integerCompressed ServerKey - Config
integerThe config type - ConfigBuilder
integerThe builder to create your config - CudaServerKey
integerandgpu - FheBool
integerThe FHE boolean data type. - FheBoolConformanceParams
integer - FheInt
integerA Generic FHE signed integer - FheInt2Id
integerId for the FheInt2 data type. - FheInt4Id
integerId for the FheInt4 data type. - FheInt6Id
integerId for the FheInt6 data type. - FheInt8Id
integerId for the FheInt8 data type. - FheInt10Id
integerId for the FheInt10 data type. - FheInt12Id
integerId for the FheInt12 data type. - FheInt14Id
integerId for the FheInt14 data type. - FheInt16Id
integerId for the FheInt16 data type. - FheInt32Id
integerId for the FheInt32 data type. - FheInt64Id
integerId for the FheInt64 data type. - FheInt128Id
integerId for the FheInt128 data type. - FheInt160Id
integerId for the FheInt160 data type. - FheInt256Id
integerId for the FheInt256 data type. - FheUint
integerA Generic FHE unsigned integer - FheUint2Id
integerId for the FheUint2 data type. - FheUint4Id
integerId for the FheUint4 data type. - FheUint6Id
integerId for the FheUint6 data type. - FheUint8Id
integerId for the FheUint8 data type. - FheUint10Id
integerId for the FheUint10 data type. - FheUint12Id
integerId for the FheUint12 data type. - FheUint14Id
integerId for the FheUint14 data type. - FheUint16Id
integerId for the FheUint16 data type. - FheUint32Id
integerId for the FheUint32 data type. - FheUint64Id
integerId for the FheUint64 data type. - FheUint128Id
integerId for the FheUint128 data type. - FheUint160Id
integerId for the FheUint160 data type. - FheUint256Id
integerId for the FheUint256 data type. - KeySwitchingKey
integer - PublicKey
integerClassical public key. - A seed value, used to initialize a generator.
- ServerKey
integerKey of the server
Enums§
- CompressedFheBool
integerCompressed FheBool - Device
integerDevices supported by tfhe-rs
Traits§
- IntegerId
integerTrait to mark ID type for integers
Functions§
- generate_keys
integerGenerates keys using the provided config. - safe_serialize
integer - set_server_key
integerThe function used to initialize internal keys. - unset_server_key
integer - with_server_key_as_context
integer
Type Aliases§
- CompactFheInt2
integerA compact signed integer type with 2 bits - CompactFheInt2List
integerA compact list of signed integer type with 2 bits - CompactFheInt4
integerA compact signed integer type with 4 bits - CompactFheInt4List
integerA compact list of signed integer type with 4 bits - CompactFheInt6
integerA compact signed integer type with 6 bits - CompactFheInt6List
integerA compact list of signed integer type with 6 bits - CompactFheInt8
integerA compact signed integer type with 8 bits - CompactFheInt8List
integerA compact list of signed integer type with 8 bits - CompactFheInt10
integerA compact signed integer type with 10 bits - CompactFheInt10List
integerA compact list of signed integer type with 10 bits - CompactFheInt12
integerA compact signed integer type with 12 bits - CompactFheInt12List
integerA compact list of signed integer type with 12 bits - CompactFheInt14
integerA compact signed integer type with 14 bits - CompactFheInt14List
integerA compact list of signed integer type with 14 bits - CompactFheInt16
integerA compact signed integer type with 16 bits - CompactFheInt16List
integerA compact list of signed integer type with 16 bits - CompactFheInt32
integerA compact signed integer type with 32 bits - CompactFheInt32List
integerA compact list of signed integer type with 32 bits - CompactFheInt64
integerA compact signed integer type with 64 bits - CompactFheInt64List
integerA compact list of signed integer type with 64 bits - CompactFheInt128
integerA compact signed integer type with 128 bits - CompactFheInt128List
integerA compact list of signed integer type with 128 bits - CompactFheInt160
integerA compact signed integer type with 160 bits - CompactFheInt160List
integerA compact list of signed integer type with 160 bits - CompactFheInt256
integerA compact signed integer type with 256 bits - CompactFheInt256List
integerA 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
integerA compressed signed integer type with 2 bits - CompressedFheInt4
integerA compressed signed integer type with 4 bits - CompressedFheInt6
integerA compressed signed integer type with 6 bits - CompressedFheInt8
integerA compressed signed integer type with 8 bits - CompressedFheInt10
integerA compressed signed integer type with 10 bits - CompressedFheInt12
integerA compressed signed integer type with 12 bits - CompressedFheInt14
integerA compressed signed integer type with 14 bits - CompressedFheInt16
integerA compressed signed integer type with 16 bits - CompressedFheInt32
integerA compressed signed integer type with 32 bits - CompressedFheInt64
integerA compressed signed integer type with 64 bits - CompressedFheInt128
integerA compressed signed integer type with 128 bits - CompressedFheInt160
integerA compressed signed integer type with 160 bits - CompressedFheInt256
integerA 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
integerA signed integer type with 2 bits - FheInt2ConformanceParams
integer - FheInt4
integerA signed integer type with 4 bits - FheInt4ConformanceParams
integer - FheInt6
integerA signed integer type with 6 bits - FheInt6ConformanceParams
integer - FheInt8
integerA signed integer type with 8 bits - FheInt8ConformanceParams
integer - FheInt10
integerA signed integer type with 10 bits - FheInt10ConformanceParams
integer - FheInt12
integerA signed integer type with 12 bits - FheInt12ConformanceParams
integer - FheInt14
integerA signed integer type with 14 bits - FheInt14ConformanceParams
integer - FheInt16
integerA signed integer type with 16 bits - FheInt16ConformanceParams
integer - FheInt32
integerA signed integer type with 32 bits - FheInt32ConformanceParams
integer - FheInt64
integerA signed integer type with 64 bits - FheInt64ConformanceParams
integer - FheInt128
integerA signed integer type with 128 bits - FheInt128ConformanceParams
integer - FheInt160
integerA signed integer type with 160 bits - FheInt160ConformanceParams
integer - FheInt256
integerA signed integer type with 256 bits - FheInt256ConformanceParams
integer - FheUint2
integerAn unsigned integer type with 2 bits - FheUint2ConformanceParams
integer - FheUint4
integerAn unsigned integer type with 4 bits - FheUint4ConformanceParams
integer - FheUint6
integerAn unsigned integer type with 6 bits - FheUint6ConformanceParams
integer - FheUint8
integerAn unsigned integer type with 8 bits - FheUint8ConformanceParams
integer - FheUint10
integerAn unsigned integer type with 10 bits - FheUint10ConformanceParams
integer - FheUint12
integerAn unsigned integer type with 12 bits - FheUint12ConformanceParams
integer - FheUint14
integerAn unsigned integer type with 14 bits - FheUint14ConformanceParams
integer - FheUint16
integerAn unsigned integer type with 16 bits - FheUint16ConformanceParams
integer - FheUint32
integerAn unsigned integer type with 32 bits - FheUint32ConformanceParams
integer - FheUint64
integerAn unsigned integer type with 64 bits - FheUint64ConformanceParams
integer - FheUint128
integerAn unsigned integer type with 128 bits - FheUint128ConformanceParams
integer - FheUint160
integerAn unsigned integer type with 160 bits - FheUint160ConformanceParams
integer - FheUint256
integerAn unsigned integer type with 256 bits - FheUint256ConformanceParams
integer