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.
Modules
- boolean
boolean
Welcome to the TFHE-rsboolean
module documentation! - Welcome to the TFHE-rs
core_crypto
module documentation! - errors
boolean
orshortint
orinteger
- integer
integer
Welcome to the TFHE-rsinteger
module documentation! - parameters
boolean
orshortint
orinteger
- prelude
boolean
orshortint
orinteger
The tfhe prelude. The purpose of this module is to make it easier to have the most commonly needed traits of this crate. - shortint
shortint
Welcome to the TFHE-rsshortint
module documentation!
Structs
- ClientKey
boolean
orshortint
orinteger
Key of the client - CompressedPublicKey
boolean
orshortint
orinteger
- Config
boolean
orshortint
orinteger
The config type - ConfigBuilder
boolean
orshortint
orinteger
The builder to create your config - CrtParameters
integer
and (boolean
orshortint
orinteger
)Parameters for ‘CRT’ decomposition - FheBoolParameters
boolean
and (boolean
orshortint
orinteger
)Parameters for FheBool. - GenericInteger
integer
A Generic FHE unsigned integer - OutOfRangeError
boolean
orshortint
orinteger
Error when trying to create a short integer from a value that was too big to be represented - PublicKey
boolean
orshortint
orinteger
- RadixParameters
integer
and (boolean
orshortint
orinteger
)Parameters for ‘radix’ decomposition - ServerKey
boolean
orshortint
orinteger
Key of the server
Enums
- Error
boolean
orshortint
orinteger
Functions
- generate_keys
boolean
orshortint
orinteger
Generates keys using the provided config. - set_server_key
boolean
orshortint
orinteger
The function used to initialize internal keys. - unset_server_key
boolean
orshortint
orinteger
- with_server_key_as_context
boolean
orshortint
orinteger
Type Definitions
- CompressedFheBool
boolean
and (boolean
orshortint
orinteger
) - CompressedFheUint2
shortint
and (boolean
orshortint
orinteger
) - CompressedFheUint3
shortint
and (boolean
orshortint
orinteger
) - CompressedFheUint4
shortint
and (boolean
orshortint
orinteger
) - CompressedFheUint8
integer
and (boolean
orshortint
orinteger
) - CompressedFheUint10
integer
and (boolean
orshortint
orinteger
) - CompressedFheUint12
integer
and (boolean
orshortint
orinteger
) - CompressedFheUint14
integer
and (boolean
orshortint
orinteger
) - CompressedFheUint16
integer
and (boolean
orshortint
orinteger
) - CompressedFheUint32
integer
and (boolean
orshortint
orinteger
) - CompressedFheUint64
integer
and (boolean
orshortint
orinteger
) - CompressedFheUint128
integer
and (boolean
orshortint
orinteger
) - CompressedFheUint256
integer
and (boolean
orshortint
orinteger
) - FheBool
boolean
and (boolean
orshortint
orinteger
) - FheUint2
shortint
and (boolean
orshortint
orinteger
)An unsigned integer type with 2 bits. - FheUint2Parameters
shortint
and (boolean
orshortint
orinteger
)Parameters for the FheUint2 data type. - FheUint3
shortint
and (boolean
orshortint
orinteger
)An unsigned integer type with 3 bits. - FheUint3Parameters
shortint
and (boolean
orshortint
orinteger
)Parameters for the FheUint3 data type. - FheUint4
shortint
and (boolean
orshortint
orinteger
)An unsigned integer type with 4 bits. - FheUint4Parameters
shortint
and (boolean
orshortint
orinteger
)Parameters for the FheUint4 data type. - FheUint8
integer
and (boolean
orshortint
orinteger
)An unsigned integer type with8bits - FheUint10
integer
and (boolean
orshortint
orinteger
)An unsigned integer type with10bits - FheUint12
integer
and (boolean
orshortint
orinteger
)An unsigned integer type with12bits - FheUint14
integer
and (boolean
orshortint
orinteger
)An unsigned integer type with14bits - FheUint16
integer
and (boolean
orshortint
orinteger
)An unsigned integer type with16bits - FheUint32
integer
and (boolean
orshortint
orinteger
)An unsigned integer type with32bits - FheUint64
integer
and (boolean
orshortint
orinteger
)An unsigned integer type with64bits - FheUint128
integer
and (boolean
orshortint
orinteger
)An unsigned integer type with128bits - FheUint256
integer
and (boolean
orshortint
orinteger
)An unsigned integer type with256bits