Roots (mavryk-protocol-alpha.Mavryk_raw_protocol

type context = Raw_context.t * id

type key = int32

An abstract type for keys

type value = Mavryk_protocol_environment_alpha.Sapling.Hash.t

The type of values

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

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

val get : 
  context ->
  key ->
  value Mavryk_protocol_environment_alpha.Error_monad.tzresult
    Mavryk_protocol_environment_alpha.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 find : 
  context ->
  key ->
  value option Mavryk_protocol_environment_alpha.Error_monad.tzresult
    Mavryk_protocol_environment_alpha.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 update : 
  context ->
  key ->
  value ->
  Raw_context.t Mavryk_protocol_environment_alpha.Error_monad.tzresult
    Mavryk_protocol_environment_alpha.Lwt.t

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

val init : 
  context ->
  key ->
  value ->
  Raw_context.t Mavryk_protocol_environment_alpha.Error_monad.tzresult
    Mavryk_protocol_environment_alpha.Lwt.t

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

val add : 
  context ->
  key ->
  value ->
  Raw_context.t Mavryk_protocol_environment_alpha.Lwt.t

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

val add_or_remove : 
  context ->
  key ->
  value option ->
  Raw_context.t Mavryk_protocol_environment_alpha.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, deletes the storage bucket ; does nothing if the bucket does not exist.

val remove_existing : 
  context ->
  key ->
  Raw_context.t Mavryk_protocol_environment_alpha.Error_monad.tzresult
    Mavryk_protocol_environment_alpha.Lwt.t

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

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

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