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

octez-19.0.tar.gz

sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4

sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13

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