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

sha256=aa2f5bc99cc4ca2217c52a1af2a2cdfd3b383208cb859ca2e79ca0903396ca1d

sha512=d68bb3eb615e3dcccc845fddfc9901c95b3c6dc8e105e39522ce97637b1308a7fa7aa1d271351d5933febd7476b2819e1694f31198f1f0919681f1f9cc97cb3a

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