package octez-proto-libs

  1. Overview
  2. Docs
Octez protocol libraries

Install

Dune Dependency

Authors

Maintainers

Sources

octez-19.1.tar.gz
sha256=55ea1fb8bb3273a7fc270ca8f650d45c56449665619482aad9bc12f3ea736b7e
sha512=fec850fc2d17d7490bbabd5147d62aad13b3aaed8774270f8a38ab419670ed03e0fd30cf8642a97984eca5c2446726fe590ad99c015f7ec50919dc7652f25053

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

Module Make.RPC_answerSource

Sourcetype 'o t = [
  1. | `Ok of 'o
  2. | `OkChunk of 'o
  3. | `OkStream of 'o stream
  4. | `Created of string option
  5. | `No_content
  6. | `Unauthorized of Error_monad.error list option
  7. | `Forbidden of Error_monad.error list option
  8. | `Not_found of Error_monad.error list option
  9. | `Conflict of Error_monad.error list option
  10. | `Error of Error_monad.error list option
]

Return type for service handler

Sourceand 'a stream = {
  1. next : unit -> 'a option Lwt.t;
  2. 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
OCaml

Innovation. Community. Security.