Module Olm_c_function_descriptions.Descriptions

Parameters

Signature

val inbound_group_session_size : (unit -> Unsigned.size_t F.return) F.result
val inbound_group_session : (unit Ctypes_static.ptr -> Olm_c_types.InboundGroupSession.t Ctypes_static.ptr F.return) F.result
val inbound_group_session_last_error : (Olm_c_types.InboundGroupSession.t Ctypes_static.ptr -> char Ctypes_static.ptr F.return) F.result
val clear_inbound_group_session : (Olm_c_types.InboundGroupSession.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val pickle_inbound_group_session_length : (Olm_c_types.InboundGroupSession.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val pickle_inbound_group_session : (Olm_c_types.InboundGroupSession.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val unpickle_inbound_group_session : (Olm_c_types.InboundGroupSession.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val init_inbound_group_session : (Olm_c_types.InboundGroupSession.t Ctypes_static.ptr -> Unsigned.uint8 Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val import_inbound_group_session : (Olm_c_types.InboundGroupSession.t Ctypes_static.ptr -> Unsigned.uint8 Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val group_decrypt_max_plaintext_length : (Olm_c_types.InboundGroupSession.t Ctypes_static.ptr -> Unsigned.uint8 Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val group_decrypt : (Olm_c_types.InboundGroupSession.t Ctypes_static.ptr -> Unsigned.uint8 Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.uint8 Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.uint32 Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val inbound_group_session_id_length : (Olm_c_types.InboundGroupSession.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val inbound_group_session_id : (Olm_c_types.InboundGroupSession.t Ctypes_static.ptr -> Unsigned.uint8 Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val inbound_group_session_first_known_index : (Olm_c_types.InboundGroupSession.t Ctypes_static.ptr -> Unsigned.uint32 F.return) F.result
val inbound_group_session_is_verified : (Olm_c_types.InboundGroupSession.t Ctypes_static.ptr -> int F.return) F.result
val export_inbound_group_session_length : (Olm_c_types.InboundGroupSession.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val export_inbound_group_session : (Olm_c_types.InboundGroupSession.t Ctypes_static.ptr -> Unsigned.uint8 Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.uint32 -> Unsigned.size_t F.return) F.result
val outbound_group_session_size : (unit -> Unsigned.size_t F.return) F.result
val outbound_group_session : (unit Ctypes_static.ptr -> Olm_c_types.OutboundGroupSession.t Ctypes_static.ptr F.return) F.result
val outbound_group_session_last_error : (Olm_c_types.OutboundGroupSession.t Ctypes_static.ptr -> char Ctypes_static.ptr F.return) F.result
val clear_outbound_group_session : (Olm_c_types.OutboundGroupSession.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val pickle_outbound_group_session_length : (Olm_c_types.OutboundGroupSession.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val pickle_outbound_group_session : (Olm_c_types.OutboundGroupSession.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val unpickle_outbound_group_session : (Olm_c_types.OutboundGroupSession.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val init_outbound_group_session_random_length : (Olm_c_types.OutboundGroupSession.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val init_outbound_group_session : (Olm_c_types.OutboundGroupSession.t Ctypes_static.ptr -> Unsigned.uint8 Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val group_encrypt_message_length : (Olm_c_types.OutboundGroupSession.t Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val group_encrypt : (Olm_c_types.OutboundGroupSession.t Ctypes_static.ptr -> Unsigned.uint8 Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.uint8 Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val outbound_group_session_id_length : (Olm_c_types.OutboundGroupSession.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val outbound_group_session_id : (Olm_c_types.OutboundGroupSession.t Ctypes_static.ptr -> Unsigned.uint8 Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val outbound_group_session_message_index : (Olm_c_types.OutboundGroupSession.t Ctypes_static.ptr -> Unsigned.uint32 F.return) F.result
val outbound_group_session_key_length : (Olm_c_types.OutboundGroupSession.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val outbound_group_session_key : (Olm_c_types.OutboundGroupSession.t Ctypes_static.ptr -> Unsigned.uint8 Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val get_library_version : (Unsigned.uint8 Ctypes_static.ptr -> Unsigned.uint8 Ctypes_static.ptr -> Unsigned.uint8 Ctypes_static.ptr -> unit F.return) F.result
val account_size : (unit -> Unsigned.size_t F.return) F.result
val session_size : (unit -> Unsigned.size_t F.return) F.result
val utility_size : (unit -> Unsigned.size_t F.return) F.result
val account : (unit Ctypes_static.ptr -> Olm_c_types.Account.t Ctypes_static.ptr F.return) F.result
val session : (unit Ctypes_static.ptr -> Olm_c_types.Session.t Ctypes_static.ptr F.return) F.result
val utility : (unit Ctypes_static.ptr -> Olm_c_types.Utility.t Ctypes_static.ptr F.return) F.result
val error : (unit -> Unsigned.size_t F.return) F.result
val account_last_error : (Olm_c_types.Account.t Ctypes_static.ptr -> char Ctypes_static.ptr F.return) F.result
val session_last_error : (Olm_c_types.Session.t Ctypes_static.ptr -> char Ctypes_static.ptr F.return) F.result
val utility_last_error : (Olm_c_types.Utility.t Ctypes_static.ptr -> char Ctypes_static.ptr F.return) F.result
val clear_account : (Olm_c_types.Account.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val clear_session : (Olm_c_types.Session.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val clear_utility : (Olm_c_types.Utility.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val pickle_account_length : (Olm_c_types.Account.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val pickle_session_length : (Olm_c_types.Session.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val pickle_account : (Olm_c_types.Account.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val pickle_session : (Olm_c_types.Session.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val unpickle_account : (Olm_c_types.Account.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val unpickle_session : (Olm_c_types.Session.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val create_account_random_length : (Olm_c_types.Account.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val create_account : (Olm_c_types.Account.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val account_identity_keys_length : (Olm_c_types.Account.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val account_identity_keys : (Olm_c_types.Account.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val account_signature_length : (Olm_c_types.Account.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val account_sign : (Olm_c_types.Account.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val account_one_time_keys_length : (Olm_c_types.Account.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val account_one_time_keys : (Olm_c_types.Account.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val account_mark_keys_as_published : (Olm_c_types.Account.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val account_max_number_of_one_time_keys : (Olm_c_types.Account.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val account_generate_one_time_keys_random_length : (Olm_c_types.Account.t Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val account_generate_one_time_keys : (Olm_c_types.Account.t Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val account_generate_fallback_key_random_length : (Olm_c_types.Account.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val account_generate_fallback_key : (Olm_c_types.Account.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val account_fallback_key_length : (Olm_c_types.Account.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val account_fallback_key : (Olm_c_types.Account.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val create_outbound_session_random_length : (Olm_c_types.Session.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val create_outbound_session : (Olm_c_types.Session.t Ctypes_static.ptr -> Olm_c_types.Account.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val create_inbound_session : (Olm_c_types.Session.t Ctypes_static.ptr -> Olm_c_types.Account.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val create_inbound_session_from : (Olm_c_types.Session.t Ctypes_static.ptr -> Olm_c_types.Account.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val session_id_length : (Olm_c_types.Session.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val session_id : (Olm_c_types.Session.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val session_has_received_message : (Olm_c_types.Session.t Ctypes_static.ptr -> int F.return) F.result
val session_describe : (Olm_c_types.Session.t Ctypes_static.ptr -> char Ctypes_static.ptr -> Unsigned.size_t -> unit F.return) F.result
val matches_inbound_session : (Olm_c_types.Session.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val matches_inbound_session_from : (Olm_c_types.Session.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val remove_one_time_keys : (Olm_c_types.Account.t Ctypes_static.ptr -> Olm_c_types.Session.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val encrypt_message_type : (Olm_c_types.Session.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val encrypt_random_length : (Olm_c_types.Session.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val encrypt_message_length : (Olm_c_types.Session.t Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val encrypt : (Olm_c_types.Session.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val decrypt_max_plaintext_length : (Olm_c_types.Session.t Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val decrypt : (Olm_c_types.Session.t Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val sha256_length : (Olm_c_types.Utility.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val sha256 : (Olm_c_types.Utility.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val ed25519_verify : (Olm_c_types.Utility.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val pk_encryption_size : (unit -> Unsigned.size_t F.return) F.result
val pk_encryption : (unit Ctypes_static.ptr -> Olm_c_types.PkEncryption.t Ctypes_static.ptr F.return) F.result
val pk_encryption_last_error : (Olm_c_types.PkEncryption.t Ctypes_static.ptr -> char Ctypes_static.ptr F.return) F.result
val clear_pk_encryption : (Olm_c_types.PkEncryption.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val pk_encryption_set_recipient_key : (Olm_c_types.PkEncryption.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val pk_ciphertext_length : (Olm_c_types.PkEncryption.t Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val pk_mac_length : (Olm_c_types.PkEncryption.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val pk_key_length : (unit -> Unsigned.size_t F.return) F.result
val pk_encrypt_random_length : (Olm_c_types.PkEncryption.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val pk_encrypt : (Olm_c_types.PkEncryption.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val pk_decryption_size : (unit -> Unsigned.size_t F.return) F.result
val pk_decryption : (unit Ctypes_static.ptr -> Olm_c_types.PkDecryption.t Ctypes_static.ptr F.return) F.result
val pk_decryption_last_error : (Olm_c_types.PkDecryption.t Ctypes_static.ptr -> char Ctypes_static.ptr F.return) F.result
val clear_pk_decryption : (Olm_c_types.PkDecryption.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val pk_private_key_length : (unit -> Unsigned.size_t F.return) F.result
val pk_key_from_private : (Olm_c_types.PkDecryption.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val pickle_pk_decryption_length : (Olm_c_types.PkDecryption.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val pickle_pk_decryption : (Olm_c_types.PkDecryption.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val unpickle_pk_decryption : (Olm_c_types.PkDecryption.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val pk_max_plaintext_length : (Olm_c_types.PkDecryption.t Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val pk_decrypt : (Olm_c_types.PkDecryption.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val pk_get_private_key : (Olm_c_types.PkDecryption.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val pk_signing_size : (unit -> Unsigned.size_t F.return) F.result
val pk_signing : (unit Ctypes_static.ptr -> Olm_c_types.PkSigning.t Ctypes_static.ptr F.return) F.result
val pk_signing_last_error : (Olm_c_types.PkSigning.t Ctypes_static.ptr -> char Ctypes_static.ptr F.return) F.result
val clear_pk_signing : (Olm_c_types.PkSigning.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val pk_signing_key_from_seed : (Olm_c_types.PkSigning.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val pk_signing_seed_length : (unit -> Unsigned.size_t F.return) F.result
val pk_signing_public_key_length : (unit -> Unsigned.size_t F.return) F.result
val pk_signature_length : (unit -> Unsigned.size_t F.return) F.result
val pk_sign : (Olm_c_types.PkSigning.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val sas_last_error : (Olm_c_types.SAS.t Ctypes_static.ptr -> char Ctypes_static.ptr F.return) F.result
val sas_size : (unit -> Unsigned.size_t F.return) F.result
val sas : (unit Ctypes_static.ptr -> Olm_c_types.SAS.t Ctypes_static.ptr F.return) F.result
val clear_sas : (Olm_c_types.SAS.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val create_sas_random_length : (Olm_c_types.SAS.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val create_sas : (Olm_c_types.SAS.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val sas_pubkey_length : (Olm_c_types.SAS.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val sas_get_pubkey : (Olm_c_types.SAS.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val sas_set_their_key : (Olm_c_types.SAS.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val sas_is_their_key_set : (Olm_c_types.SAS.t Ctypes_static.ptr -> int F.return) F.result
val sas_generate_bytes : (Olm_c_types.SAS.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val sas_mac_length : (Olm_c_types.SAS.t Ctypes_static.ptr -> Unsigned.size_t F.return) F.result
val sas_calculate_mac : (Olm_c_types.SAS.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result
val sas_calculate_mac_long_kdf : (Olm_c_types.SAS.t Ctypes_static.ptr -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> unit Ctypes_static.ptr -> Unsigned.size_t -> Unsigned.size_t F.return) F.result