package octez-proto-libs

You can search for identifiers within the package.

in-package search v0.2.0

Octez protocol libraries

Install

Dune Dependency

www.tezos.com Readme Edit opam file Versions (5)

Authors

T

Tezos devteam

Maintainers

C

contact@tezos.com

Sources

tezos-octez-v20.1.tag.bz2

sha256=ddfb5076eeb0b32ac21c1eed44e8fc86a6743ef18ab23fff02d36e365bb73d61

sha512=d22a827df5146e0aa274df48bc2150b098177ff7e5eab52c6109e867eb0a1f0ec63e6bfbb0e3645a6c2112de3877c91a17df32ccbff301891ce4ba630c997a65

doc/octez-proto-libs.protocol-environment/Tezos_protocol_environment/V7/Make/RPC_answer/index.html

Module `Make.RPC_answer`Source

Sourcetype 'o t = [

| `Ok of 'o
| `OkChunk of 'o
| `OkStream of 'o stream
| `Created of string option
| `No_content
| `Unauthorized of Error_monad.error list option
| `Forbidden of Error_monad.error list option
| `Not_found of Error_monad.error list option
| `Conflict of Error_monad.error list option
| `Error of Error_monad.error list option

]

Return type for service handler

Sourceand 'a stream = {

next : unit -> 'a option Lwt.t;
shutdown : unit -> unit;

}

Sourceval return : 'o -> 'o t Lwt.t

Sourceval return_chunked : 'o -> 'o t Lwt.t

return_chunked is identical to return but it indicates to the server that the result might be long and that the serialisation should be done in mutliple chunks.

You should use return_chunked when returning an (unbounded or potentially large) list, array, map, or other such set.

Sourceval return_stream : 'o stream -> 'o t Lwt.t

Sourceval not_found : 'o t Lwt.t

Sourceval fail : Error_monad.error list -> 'a t Lwt.t