package tezos-protocol-008-PtEdoTez

  1. Overview
  2. Docs
package tezos-protocol-008-PtEdoTez
Legend:
Library
Module
Module type
Parameter
Class
Class type
type context = Raw_context.t * id
type key = int32

An abstract type for keys

type value = Tezos_sapling__Core.Client.Hash.t

The type of values

val mem : context -> key -> bool Lwt.t

Tells if a given key is already bound to a storage bucket

val get : context -> key -> (value, Tezos_protocol_environment_008_PtEdoTez__Environment.Error_monad.error list) Stdlib.result Lwt.t

Retrieve a value from the storage bucket at a given key ; returns Storage_errorMissing_key if the key is not set ; returns Storage_errorCorrupted_data if the deserialisation fails.

val get_option : context -> key -> (value option, Tezos_protocol_environment_008_PtEdoTez__Environment.Error_monad.error list) Stdlib.result Lwt.t

Retrieve a value from the storage bucket at a given key ; returns None if the value is not set ; returns Storage_error Corrupted_data if the deserialisation fails.

val set : context -> key -> value -> (Raw_context.t, Tezos_protocol_environment_008_PtEdoTez__Environment.Error_monad.error list) Stdlib.result Lwt.t

Updates the content of a bucket ; returns A Storage_Error Missing_key if the value does not exists.

val init : context -> key -> value -> (Raw_context.t, Tezos_protocol_environment_008_PtEdoTez__Environment.Error_monad.error list) Stdlib.result Lwt.t

Allocates a storage bucket at the given key and initializes it ; returns a Storage_errorExisting_key if the bucket exists.

val init_set : context -> key -> value -> Raw_context.t Lwt.t

Allocates a storage bucket at the given key and initializes it with a value ; just updates it if the bucket exists.

val set_option : context -> key -> value option -> Raw_context.t Lwt.t

When the value is Some v, allocates the data and initializes it with v ; just updates it if the bucket exists. When the value is None, delete the storage bucket when the value ; does nothing if the bucket does not exists.

val delete : context -> key -> (Raw_context.t, Tezos_protocol_environment_008_PtEdoTez__Environment.Error_monad.error list) Stdlib.result Lwt.t

Delete a storage bucket and its contents ; returns a Storage_errorMissing_key if the bucket does not exists.

val remove : context -> key -> Raw_context.t Lwt.t

Removes a storage bucket and its contents ; does nothing if the bucket does not exists.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct