package tezos-protocol-002-PsYLVpVv

  1. Overview
  2. Docs
package tezos-protocol-002-PsYLVpVv
Legend:
Library
Module
Module type
Parameter
Class
Class type

The next roll to be allocated.

type context = Raw_context.t
type value = Roll_repr.t

The type of the value

val mem : context -> bool Lwt.t

Tells if the data is already defined

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

Retrieve the value from the storage bucket ; returns a Storage_error if the key is not set or if the deserialisation fails

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

Retrieves the value from the storage bucket ; returns None if the data is not initialized, or Storage_helpers.Storage_error if the deserialisation fails

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

Allocates the storage bucket and initializes it ; returns a Storage_errorMissing_key if the bucket exists

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

Updates the content of the bucket ; returns a Storage_Error Existing_key if the value does not exists

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

Allocates the data and initializes it with a value ; just updates it if the bucket exists

val set_option : context -> 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 valus is None, delete the storage bucket when the value ; does nothing if the bucket does not exists.

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

Delete the storage bucket ; returns a Storage_error Missing_key if the bucket does not exists

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

Removes the 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