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-18.0.tar.gz

sha256=dbc3b675aee59c2c574e5d0a771193a2ecfca31e7a5bc5aed66598080596ce1c

sha512=b97ed762b9d24744305c358af0d20f394376b64bfdd758dd4a81775326caf445caa57c4f6445da3dd6468ff492de18e4c14af6f374dfcbb7e4d64b7b720e5e2a

doc/octez-proto-libs.protocol-environment/Tezos_protocol_environment/V4/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