package tezos-protocol-003-PsddFKi3
Install
dune-project
Dependency
Authors
Maintainers
Sources
sha256=ad9e08819871c75ba6f4530b125f7d157799398e4d77a1e6bfea9d91ff37ff55
sha512=c5dc4d40cc09bc6980fbbdb5c2e105bf4252cf9cfcb2b49660b0ebe4dc789f6709ec3b3bf2f87d81580d3eed9521eeb1c960f24d9b14eb0285aaba1f84d10a9b
doc/tezos-protocol-003-PsddFKi3.raw/Tezos_raw_protocol_003_PsddFKi3/Storage/Contract/Code/index.html
Module Contract.CodeSource
An abstract type for keys
The type of values
val mem :
context ->
key ->
(Raw_context.t * bool)
Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
Tezos_protocol_environment_003_PsddFKi3.Lwt.tTells if a given key is already bound to a storage bucket. Consumes Gas_repr.read_bytes_cost Z.zero.
val get :
context ->
key ->
(Raw_context.t * value)
Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
Tezos_protocol_environment_003_PsddFKi3.Lwt.tRetrieve 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. Consumes Gas_repr.read_bytes_cost <size of the value>.
val get_option :
context ->
key ->
(Raw_context.t * value option)
Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
Tezos_protocol_environment_003_PsddFKi3.Lwt.tRetrieve 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. Consumes Gas_repr.read_bytes_cost <size of the value> if present or Gas_repr.read_bytes_cost Z.zero.
val set :
context ->
key ->
value ->
(Raw_context.t * int)
Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
Tezos_protocol_environment_003_PsddFKi3.Lwt.tUpdates the content of a bucket ; returns A Storage_Error
Missing_key if the value does not exists. Consumes serialization cost. Consumes Gas_repr.write_bytes_cost <size of the new value>. Returns the difference from the old to the new size.
val init :
context ->
key ->
value ->
(Raw_context.t * int)
Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
Tezos_protocol_environment_003_PsddFKi3.Lwt.tAllocates a storage bucket at the given key and initializes it ; returns a Storage_errorExisting_key if the bucket exists. Consumes serialization cost. Consumes Gas_repr.write_bytes_cost <size of the value>. Returns the size.
val init_set :
context ->
key ->
value ->
(Raw_context.t * int)
Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
Tezos_protocol_environment_003_PsddFKi3.Lwt.tAllocates a storage bucket at the given key and initializes it with a value ; just updates it if the bucket exists. Consumes serialization cost. Consumes Gas_repr.write_bytes_cost <size of the new value>. Returns the difference from the old (maybe 0) to the new size.
val set_option :
context ->
key ->
value option ->
(Raw_context.t * int)
Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
Tezos_protocol_environment_003_PsddFKi3.Lwt.tWhen 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. Consumes serialization cost. Consumes the same gas cost as either remove or init_set. Returns the difference from the old (maybe 0) to the new size.
val delete :
context ->
key ->
(Raw_context.t * int)
Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
Tezos_protocol_environment_003_PsddFKi3.Lwt.tDelete a storage bucket and its contents ; returns a Storage_errorMissing_key if the bucket does not exists. Consumes Gas_repr.write_bytes_cost Z.zero. Returns the freed size.
val remove :
context ->
key ->
(Raw_context.t * int)
Tezos_protocol_environment_003_PsddFKi3.Error_monad.tzresult
Tezos_protocol_environment_003_PsddFKi3.Lwt.tRemoves a storage bucket and its contents ; does nothing if the bucket does not exists. Consumes Gas_repr.write_bytes_cost Z.zero. Returns the freed size.