package octez-libs

  1. Overview
  2. Docs
package octez-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type
class type 'pr gen_simple = object ... end
class type 'pr gen_streamed = object ... end
class type 'pr gen = object ... end
class type simple = object ... end
class type streamed = object ... end
class type t = object ... end
type ('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

type ('o, 'e) rest_result = ('o, 'e) rest Tezos_error_monad.Error_monad.tzresult
type 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

class type generic = object ... end
type 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;
    }
val 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
val 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
type stopper = unit -> unit
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct