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!
• errorsboolean or shortint or integer
• integerinteger
  Welcome to the TFHE-rs integer module documentation!
• named
• parametersboolean or shortint or integer
• preludeboolean or shortint or integer
  The tfhe prelude. The purpose of this module is to make it easier to have the most commonly needed traits of this crate.
• shortintshortint
  Welcome to the TFHE-rs shortint module documentation!

Structs

• ClientKeyboolean or shortint or integer
  Key of the client
• CompactPublicKeyboolean or shortint or integer
• CompressedCompactPublicKeyboolean or shortint or integer
• CompressedFheBoolboolean and (boolean or shortint or integer)
• CompressedPublicKeyboolean or shortint or integer
• CompressedServerKeyboolean or shortint or integer
• Configboolean or shortint or integer
  The config type
• ConfigBuilderboolean or shortint or integer
  The builder to create your config
• FheBoolboolean and (boolean or shortint or integer)
  The FHE boolean data type.
• FheBoolParametersboolean and (boolean or shortint or integer)
  Parameters for FheBool.
• OutOfRangeErrorboolean or shortint or integer
  Error when trying to create a short integer from a value that was too big to be represented
• PublicKeyboolean or shortint or integer
• Seed
  A seed value, used to initialize a generator.
• ServerKeyboolean or shortint or integer
  Key of the server

Enums

• Errorboolean or shortint or integer

Functions

• generate_keysboolean or shortint or integer
  Generates keys using the provided config.
• set_server_keyboolean or shortint or integer
  The function used to initialize internal keys.
• unset_server_keyboolean or shortint or integer
• with_server_key_as_contextboolean or shortint or integer

Type Aliases

• CompactFheInt8integer and (boolean or shortint or integer)
• CompactFheInt8Listinteger and (boolean or shortint or integer)
• CompactFheInt16integer and (boolean or shortint or integer)
• CompactFheInt16Listinteger and (boolean or shortint or integer)
• CompactFheInt32integer and (boolean or shortint or integer)
• CompactFheInt32Listinteger and (boolean or shortint or integer)
• CompactFheInt64integer and (boolean or shortint or integer)
• CompactFheInt64Listinteger and (boolean or shortint or integer)
• CompactFheInt128integer and (boolean or shortint or integer)
• CompactFheInt128Listinteger and (boolean or shortint or integer)
• CompactFheInt256integer and (boolean or shortint or integer)
• CompactFheInt256Listinteger and (boolean or shortint or integer)
• CompactFheUint8integer and (boolean or shortint or integer)
• CompactFheUint8Listinteger and (boolean or shortint or integer)
• CompactFheUint10integer and (boolean or shortint or integer)
• CompactFheUint10Listinteger and (boolean or shortint or integer)
• CompactFheUint12integer and (boolean or shortint or integer)
• CompactFheUint12Listinteger and (boolean or shortint or integer)
• CompactFheUint14integer and (boolean or shortint or integer)
• CompactFheUint14Listinteger and (boolean or shortint or integer)
• CompactFheUint16integer and (boolean or shortint or integer)
• CompactFheUint16Listinteger and (boolean or shortint or integer)
• CompactFheUint32integer and (boolean or shortint or integer)
• CompactFheUint32Listinteger and (boolean or shortint or integer)
• CompactFheUint64integer and (boolean or shortint or integer)
• CompactFheUint64Listinteger and (boolean or shortint or integer)
• CompactFheUint128integer and (boolean or shortint or integer)
• CompactFheUint128Listinteger and (boolean or shortint or integer)
• CompactFheUint256integer and (boolean or shortint or integer)
• CompactFheUint256Listinteger and (boolean or shortint or integer)
• CompressedFheInt8integer and (boolean or shortint or integer)
• CompressedFheInt16integer and (boolean or shortint or integer)
• CompressedFheInt32integer and (boolean or shortint or integer)
• CompressedFheInt64integer and (boolean or shortint or integer)
• CompressedFheInt128integer and (boolean or shortint or integer)
• CompressedFheInt256integer and (boolean or shortint or integer)
• CompressedFheUint2shortint and (boolean or shortint or integer)
• CompressedFheUint3shortint and (boolean or shortint or integer)
• CompressedFheUint4shortint and (boolean or shortint or integer)
• CompressedFheUint8integer and (boolean or shortint or integer)
• CompressedFheUint10integer and (boolean or shortint or integer)
• CompressedFheUint12integer and (boolean or shortint or integer)
• CompressedFheUint14integer and (boolean or shortint or integer)
• CompressedFheUint16integer and (boolean or shortint or integer)
• CompressedFheUint32integer and (boolean or shortint or integer)
• CompressedFheUint64integer and (boolean or shortint or integer)
• CompressedFheUint128integer and (boolean or shortint or integer)
• CompressedFheUint256integer and (boolean or shortint or integer)
• FheInt8integer and (boolean or shortint or integer)
  An unsigned integer type with8bits
• FheInt16integer and (boolean or shortint or integer)
  An unsigned integer type with16bits
• FheInt32integer and (boolean or shortint or integer)
  An unsigned integer type with32bits
• FheInt64integer and (boolean or shortint or integer)
  An unsigned integer type with64bits
• FheInt128integer and (boolean or shortint or integer)
  An unsigned integer type with128bits
• FheInt256integer and (boolean or shortint or integer)
  An unsigned integer type with256bits
• FheUint2shortint and (boolean or shortint or integer)
  An unsigned integer type with 2 bits.
• FheUint2Parametersshortint and (boolean or shortint or integer)
  Parameters for the FheUint2 data type.
• FheUint3shortint and (boolean or shortint or integer)
  An unsigned integer type with 3 bits.
• FheUint3Parametersshortint and (boolean or shortint or integer)
  Parameters for the FheUint3 data type.
• FheUint4shortint and (boolean or shortint or integer)
  An unsigned integer type with 4 bits.
• FheUint4Parametersshortint and (boolean or shortint or integer)
  Parameters for the FheUint4 data type.
• FheUint8integer and (boolean or shortint or integer)
  An unsigned integer type with8bits
• FheUint10integer and (boolean or shortint or integer)
  An unsigned integer type with10bits
• FheUint12integer and (boolean or shortint or integer)
  An unsigned integer type with12bits
• FheUint14integer and (boolean or shortint or integer)
  An unsigned integer type with14bits
• FheUint16integer and (boolean or shortint or integer)
  An unsigned integer type with16bits
• FheUint32integer and (boolean or shortint or integer)
  An unsigned integer type with32bits
• FheUint64integer and (boolean or shortint or integer)
  An unsigned integer type with64bits
• FheUint128integer and (boolean or shortint or integer)
  An unsigned integer type with128bits
• FheUint256integer and (boolean or shortint or integer)
  An unsigned integer type with256bits