package octez-libs

  1. Overview
  2. Docs
A package that contains multiple base libraries used by the Octez suite

Install

Dune Dependency

Authors

Maintainers

Sources

octez-19.0.tar.gz
sha256=c6df840ebbf115e454db949028c595bec558a59a66cade73b52a6d099d6fa4d4
sha512=d8aee903b9fe130d73176bc8ec38b78c9ff65317da3cb4f3415f09af0c625b4384e7498201fdb61aa39086a7d5d409d0ab3423f9bc3ab989a680cf444a79bc13

doc/octez-libs.rpc/Tezos_rpc/Context/index.html

Module Tezos_rpc.ContextSource

Sourceclass type 'pr gen_simple = object ... end
Sourceclass type 'pr gen_streamed = object ... end
Sourceclass type 'pr gen = object ... end
Sourceclass type simple = object ... end
Sourceclass type streamed = object ... end
Sourceclass type t = object ... end
Sourcetype ('o, 'e) rest = [
  1. | `Ok of 'o
  2. | `Conflict of 'e
  3. | `Error of 'e
  4. | `Forbidden of 'e
  5. | `Not_found of 'e
  6. | `Gone of 'e
  7. | `Unauthorized of 'e
]

'o is the type of the result (output) and 'e the type of the error

Sourcetype ('o, 'e) rest_result = ('o, 'e) rest Tezos_error_monad.Error_monad.tzresult
Sourcetype generic_call_result = [
  1. | `Json of (Data_encoding.json, Data_encoding.json option) rest
  2. | `Binary of (string, string option) rest
  3. | `Other of (string * string) option * (string, string option) rest
]

The type of a generic call result

Sourceclass type generic = object ... end
Sourcetype Tezos_error_monad.Error_monad.error +=
  1. | Not_found of {
    1. meth : [ `GET | `POST | `DELETE | `PUT | `PATCH ];
    2. uri : Uri.t;
    }
  2. | Gone of {
    1. meth : [ `GET | `POST | `DELETE | `PUT | `PATCH ];
    2. uri : Uri.t;
    }
  3. | Generic_error of {
    1. meth : [ `GET | `POST | `DELETE | `PUT | `PATCH ];
    2. uri : Uri.t;
    }
Sourceval make_call1 : ([< Resto.meth ], unit, unit * 'a, 'q, 'i, 'o, Tezos_error_monad.Error_monad.error list) Resto.MakeService(Tezos_rpc__.RPC_encoding).t -> simple -> 'a -> 'q -> 'i -> 'o Tezos_error_monad.Error_monad.tzresult Lwt.t
Sourceval make_call2 : ([< Resto.meth ], unit, (unit * 'a) * 'b, 'q, 'i, 'o, Tezos_error_monad.Error_monad.error list) Resto.MakeService(Tezos_rpc__.RPC_encoding).t -> simple -> 'a -> 'b -> 'q -> 'i -> 'o Tezos_error_monad.Error_monad.tzresult Lwt.t
Sourceval make_call3 : ([< Resto.meth ], unit, ((unit * 'a) * 'b) * 'c, 'q, 'i, 'o, Tezos_error_monad.Error_monad.error list) Resto.MakeService(Tezos_rpc__.RPC_encoding).t -> simple -> 'a -> 'b -> 'c -> 'q -> 'i -> 'o Tezos_error_monad.Error_monad.tzresult Lwt.t
Sourcetype stopper = unit -> unit
Sourceval make_streamed_call : ([< Resto.meth ], unit, 'p, 'q, 'i, 'o, Tezos_error_monad.Error_monad.error list) Resto.MakeService(Tezos_rpc__.RPC_encoding).t -> streamed -> 'p -> 'q -> 'i -> ('o Lwt_stream.t * stopper) Tezos_error_monad.Error_monad.tzresult Lwt.t
OCaml

Innovation. Community. Security.