package octez-libs

  1. Overview
  2. Docs
package octez-libs
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Service : sig ... end
type step = Resto_directory.Make(Tezos_rpc.Encoding).step =
  1. | Static of string
  2. | Dynamic of Resto.Arg.descr
  3. | DynamicTail of Resto.Arg.descr
type conflict = Resto_directory.Make(Tezos_rpc.Encoding).conflict =
  1. | CService of Resto.meth
  2. | CDir
  3. | CBuilder
  4. | CDynDescr of string * string
  5. | CTail
  6. | CTypes of Resto.Arg.descr * Resto.Arg.descr
  7. | CType of Resto.Arg.descr * string list
exception Conflict of step list * conflict
type (!'query, !'input, !'output, !'error) types = ('query, 'input, 'output, 'error) Resto_directory.Make(Tezos_rpc.Encoding).types = {
  1. query : 'query Resto.Query.t;
  2. input : 'input Service.input;
  3. output : 'output Tezos_rpc.Encoding.t;
  4. error : 'error Tezos_rpc.Encoding.t;
}
type registered_service = Resto_directory.Make(Tezos_rpc.Encoding).registered_service =
  1. | Service : {
    1. types : ('q, 'i, 'o, 'e) types;
    2. handler : 'q -> 'i -> ('o, 'e) Resto_directory.Answer.t Lwt.t;
    } -> registered_service
type 'prefix directory = 'prefix t
type lookup_error = [
  1. | `Cannot_parse_path of string list * Resto.Arg.descr * string
  2. | `Method_not_allowed of Resto.meth list
  3. | `Not_found
]
val string_of_step : step -> string
val string_of_conflict_kind : conflict -> string
val string_of_conflict : (step list * conflict) -> string
val lookup : 'prefix directory -> 'prefix -> Resto.meth -> string list -> (registered_service, [> lookup_error ]) Stdlib.result Lwt.t
val lookup_uri_desc : 'prefix directory -> 'prefix -> Resto.meth -> string list -> (string, [> lookup_error ]) Stdlib.result Lwt.t
val allowed_methods : 'prefix directory -> 'prefix -> string list -> (Resto.meth list, [> lookup_error ]) Stdlib.result Lwt.t
val transparent_lookup : 'prefix directory -> ([< Resto.meth ], 'prefix, 'params, 'query, 'input, 'output, 'error) Service.t -> 'params -> 'query -> 'input -> [> ('output, 'error) Resto_directory.Answer.t ] Lwt.t
val empty : 'prefix directory
val map : ('a -> 'b Lwt.t) -> 'b directory -> 'a directory
val prefix : ('pr, 'p) Resto.Path.path -> 'p directory -> 'pr directory
val merge : ?strategy:[ `Pick_left | `Pick_right | `Raise ] -> 'a directory -> 'a directory -> 'a directory
val register : 'prefix directory -> ([< Resto.meth ], 'prefix, 'params, 'query, 'input, 'output, 'error) Service.t -> ('params -> 'query -> 'input -> [< ('output, 'error) Resto_directory.Answer.t ] Lwt.t) -> 'prefix directory
val register0 : unit directory -> ([< Resto.meth ], unit, unit, 'q, 'i, 'o, 'e) Service.t -> ('q -> 'i -> [< ('o, 'e) Resto_directory.Answer.t ] Lwt.t) -> unit directory
val register1 : 'prefix directory -> ([< Resto.meth ], 'prefix, unit * 'a, 'q, 'i, 'o, 'e) Service.t -> ('a -> 'q -> 'i -> [< ('o, 'e) Resto_directory.Answer.t ] Lwt.t) -> 'prefix directory
val register2 : 'prefix directory -> ([< Resto.meth ], 'prefix, (unit * 'a) * 'b, 'q, 'i, 'o, 'e) Service.t -> ('a -> 'b -> 'q -> 'i -> [< ('o, 'e) Resto_directory.Answer.t ] Lwt.t) -> 'prefix directory
val register3 : 'prefix directory -> ([< Resto.meth ], 'prefix, ((unit * 'a) * 'b) * 'c, 'q, 'i, 'o, 'e) Service.t -> ('a -> 'b -> 'c -> 'q -> 'i -> [< ('o, 'e) Resto_directory.Answer.t ] Lwt.t) -> 'prefix directory
val register4 : 'prefix directory -> ([< Resto.meth ], 'prefix, (((unit * 'a) * 'b) * 'c) * 'd, 'q, 'i, 'o, 'e) Service.t -> ('a -> 'b -> 'c -> 'd -> 'q -> 'i -> [< ('o, 'e) Resto_directory.Answer.t ] Lwt.t) -> 'prefix directory
val register5 : 'prefix directory -> ([< Resto.meth ], 'prefix, ((((unit * 'a) * 'b) * 'c) * 'd) * 'f, 'q, 'i, 'o, 'e) Service.t -> ('a -> 'b -> 'c -> 'd -> 'f -> 'q -> 'i -> [< ('o, 'e) Resto_directory.Answer.t ] Lwt.t) -> 'prefix directory
val register_dynamic_directory : ?descr:string -> 'prefix directory -> ('prefix, 'a) Resto.Path.path -> ('a -> 'a directory Lwt.t) -> 'prefix directory
val register_dynamic_directory1 : ?descr:string -> 'prefix directory -> ('prefix, unit * 'a) Resto.Path.path -> ('a -> (unit * 'a) directory Lwt.t) -> 'prefix directory
val register_dynamic_directory2 : ?descr:string -> 'prefix directory -> ('prefix, (unit * 'a) * 'b) Resto.Path.path -> ('a -> 'b -> ((unit * 'a) * 'b) directory Lwt.t) -> 'prefix directory
val register_dynamic_directory3 : ?descr:string -> 'prefix directory -> ('prefix, ((unit * 'a) * 'b) * 'c) Resto.Path.path -> ('a -> 'b -> 'c -> (((unit * 'a) * 'b) * 'c) directory Lwt.t) -> 'prefix directory
val register_describe_directory_service : 'prefix directory -> ('prefix, 'prefix, 'error) Service.description_service -> 'prefix directory
val describe_directory : recurse:bool -> ?arg:'a -> 'a directory -> Tezos_rpc.Encoding.schema Resto.Description.directory Lwt.t
module Curry : sig ... end
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