Crate tfhe

Welcome to the TFHE-rs API documentation!

TFHE-rs is a fully homomorphic encryption (FHE) library that implements Zama’s variant of TFHE.

Modules

• booleanboolean
  Welcome to the TFHE-rs boolean module documentation!
• conformance
• core_crypto
  Welcome to the TFHE-rs core_crypto module documentation!
• errorsinteger
• integerinteger
  Welcome to the TFHE-rs integer module documentation!
• named
• preludeinteger
  The tfhe prelude. The purpose of this module is to make it easier to have the most commonly needed traits of this crate.
• safe_deserialization
• shortintshortint
  Welcome to the TFHE-rs shortint module documentation!

Structs

• ClientKeyinteger
  Key of the client
• CompactFheBoolinteger
  Compact FheBool
• CompactFheBoolListinteger
  Compact list of FheBool
• CompactFheIntinteger
  Compact FheInt
• CompactFheIntListinteger
  Compact list of FheInt
• CompactFheUintinteger
  Compact FheUint
• CompactFheUintListinteger
  Compact list of FheUint
• CompactPublicKeyinteger
  A more compact public key
• CompressedCompactPublicKeyinteger
  Compressed variant of CompactPublicKey
• CompressedFheBoolinteger
  Compressed FheBool
• CompressedFheIntinteger
  Compressed FheInt
• CompressedFheUintinteger
  Compressed FheUint
• CompressedPublicKeyinteger
  Compressed classical public key.
• CompressedServerKeyinteger
  Compressed ServerKey
• Configinteger
  The config type
• ConfigBuilderinteger
  The builder to create your config
• FheBoolinteger
  The FHE boolean data type.
• FheIntinteger
  A Generic FHE signed integer
• FheInt2Idinteger
  Id for the FheInt2 data type.
• FheInt4Idinteger
  Id for the FheInt4 data type.
• FheInt6Idinteger
  Id for the FheInt6 data type.
• FheInt8Idinteger
  Id for the FheInt8 data type.
• FheInt10Idinteger
  Id for the FheInt10 data type.
• FheInt12Idinteger
  Id for the FheInt12 data type.
• FheInt14Idinteger
  Id for the FheInt14 data type.
• FheInt16Idinteger
  Id for the FheInt16 data type.
• FheInt32Idinteger
  Id for the FheInt32 data type.
• FheInt64Idinteger
  Id for the FheInt64 data type.
• FheInt128Idinteger
  Id for the FheInt128 data type.
• FheInt160Idinteger
  Id for the FheInt160 data type.
• FheInt256Idinteger
  Id for the FheInt256 data type.
• FheUintinteger
  A Generic FHE unsigned integer
• FheUint2Idinteger
  Id for the FheUint2 data type.
• FheUint4Idinteger
  Id for the FheUint4 data type.
• FheUint6Idinteger
  Id for the FheUint6 data type.
• FheUint8Idinteger
  Id for the FheUint8 data type.
• FheUint10Idinteger
  Id for the FheUint10 data type.
• FheUint12Idinteger
  Id for the FheUint12 data type.
• FheUint14Idinteger
  Id for the FheUint14 data type.
• FheUint16Idinteger
  Id for the FheUint16 data type.
• FheUint32Idinteger
  Id for the FheUint32 data type.
• FheUint64Idinteger
  Id for the FheUint64 data type.
• FheUint128Idinteger
  Id for the FheUint128 data type.
• FheUint160Idinteger
  Id for the FheUint160 data type.
• FheUint256Idinteger
  Id for the FheUint256 data type.
• KeySwitchingKeyinteger
• OutOfRangeErrorinteger
  Error when trying to create a short integer from a value that was too big to be represented
• PublicKeyinteger
  Classical public key.
• Seed
  A seed value, used to initialize a generator.
• ServerKeyinteger
  Key of the server

Enums

• Deviceinteger
  Devices supported by tfhe-rs
• Errorinteger

Functions

• generate_keysinteger
  Generates keys using the provided config.
• safe_deserialize_conformantinteger
• safe_serializeinteger
• set_server_keyinteger
  The function used to initialize internal keys.
• unset_server_keyinteger
• with_server_key_as_contextinteger

Type Aliases

• CompactFheInt2integer
  A compact signed integer type with 2 bits
• CompactFheInt2Listinteger
  A compact list of signed integer type with 2 bits
• CompactFheInt4integer
  A compact signed integer type with 4 bits
• CompactFheInt4Listinteger
  A compact list of signed integer type with 4 bits
• CompactFheInt6integer
  A compact signed integer type with 6 bits
• CompactFheInt6Listinteger
  A compact list of signed integer type with 6 bits
• CompactFheInt8integer
  A compact signed integer type with 8 bits
• CompactFheInt8Listinteger
  A compact list of signed integer type with 8 bits
• CompactFheInt10integer
  A compact signed integer type with 10 bits
• CompactFheInt10Listinteger
  A compact list of signed integer type with 10 bits
• CompactFheInt12integer
  A compact signed integer type with 12 bits
• CompactFheInt12Listinteger
  A compact list of signed integer type with 12 bits
• CompactFheInt14integer
  A compact signed integer type with 14 bits
• CompactFheInt14Listinteger
  A compact list of signed integer type with 14 bits
• CompactFheInt16integer
  A compact signed integer type with 16 bits
• CompactFheInt16Listinteger
  A compact list of signed integer type with 16 bits
• CompactFheInt32integer
  A compact signed integer type with 32 bits
• CompactFheInt32Listinteger
  A compact list of signed integer type with 32 bits
• CompactFheInt64integer
  A compact signed integer type with 64 bits
• CompactFheInt64Listinteger
  A compact list of signed integer type with 64 bits
• CompactFheInt128integer
  A compact signed integer type with 128 bits
• CompactFheInt128Listinteger
  A compact list of signed integer type with 128 bits
• CompactFheInt160integer
  A compact signed integer type with 160 bits
• CompactFheInt160Listinteger
  A compact list of signed integer type with 160 bits
• CompactFheInt256integer
  A compact signed integer type with 256 bits
• CompactFheInt256Listinteger
  A compact list of signed integer type with 256 bits
• CompactFheUint2integer
• CompactFheUint2Listinteger
• CompactFheUint4integer
• CompactFheUint4Listinteger
• CompactFheUint6integer
• CompactFheUint6Listinteger
• CompactFheUint8integer
• CompactFheUint8Listinteger
• CompactFheUint10integer
• CompactFheUint10Listinteger
• CompactFheUint12integer
• CompactFheUint12Listinteger
• CompactFheUint14integer
• CompactFheUint14Listinteger
• CompactFheUint16integer
• CompactFheUint16Listinteger
• CompactFheUint32integer
• CompactFheUint32Listinteger
• CompactFheUint64integer
• CompactFheUint64Listinteger
• CompactFheUint128integer
• CompactFheUint128Listinteger
• CompactFheUint160integer
• CompactFheUint160Listinteger
• CompactFheUint256integer
• CompactFheUint256Listinteger
• CompressedFheInt2integer
  A compressed signed integer type with 2 bits
• CompressedFheInt4integer
  A compressed signed integer type with 4 bits
• CompressedFheInt6integer
  A compressed signed integer type with 6 bits
• CompressedFheInt8integer
  A compressed signed integer type with 8 bits
• CompressedFheInt10integer
  A compressed signed integer type with 10 bits
• CompressedFheInt12integer
  A compressed signed integer type with 12 bits
• CompressedFheInt14integer
  A compressed signed integer type with 14 bits
• CompressedFheInt16integer
  A compressed signed integer type with 16 bits
• CompressedFheInt32integer
  A compressed signed integer type with 32 bits
• CompressedFheInt64integer
  A compressed signed integer type with 64 bits
• CompressedFheInt128integer
  A compressed signed integer type with 128 bits
• CompressedFheInt160integer
  A compressed signed integer type with 160 bits
• CompressedFheInt256integer
  A compressed signed integer type with 256 bits
• CompressedFheUint2integer
• CompressedFheUint4integer
• CompressedFheUint6integer
• CompressedFheUint8integer
• CompressedFheUint10integer
• CompressedFheUint12integer
• CompressedFheUint14integer
• CompressedFheUint16integer
• CompressedFheUint32integer
• CompressedFheUint64integer
• CompressedFheUint128integer
• CompressedFheUint160integer
• CompressedFheUint256integer
• FheInt2integer
  A signed integer type with 2 bits
• FheInt4integer
  A signed integer type with 4 bits
• FheInt6integer
  A signed integer type with 6 bits
• FheInt8integer
  A signed integer type with 8 bits
• FheInt10integer
  A signed integer type with 10 bits
• FheInt12integer
  A signed integer type with 12 bits
• FheInt14integer
  A signed integer type with 14 bits
• FheInt16integer
  A signed integer type with 16 bits
• FheInt32integer
  A signed integer type with 32 bits
• FheInt64integer
  A signed integer type with 64 bits
• FheInt128integer
  A signed integer type with 128 bits
• FheInt160integer
  A signed integer type with 160 bits
• FheInt256integer
  A signed integer type with 256 bits
• FheUint2integer
  An unsigned integer type with 2 bits
• FheUint4integer
  An unsigned integer type with 4 bits
• FheUint6integer
  An unsigned integer type with 6 bits
• FheUint8integer
  An unsigned integer type with 8 bits
• FheUint10integer
  An unsigned integer type with 10 bits
• FheUint12integer
  An unsigned integer type with 12 bits
• FheUint14integer
  An unsigned integer type with 14 bits
• FheUint16integer
  An unsigned integer type with 16 bits
• FheUint32integer
  An unsigned integer type with 32 bits
• FheUint64integer
  An unsigned integer type with 64 bits
• FheUint128integer
  An unsigned integer type with 128 bits
• FheUint160integer
  An unsigned integer type with 160 bits
• FheUint256integer
  An unsigned integer type with 256 bits