Module `Tezos_rpc.RPC_directory`Source

include module type of struct include Resto_directory.Make(RPC_encoding) end

Sourcemodule Service = Resto_directory.Make(RPC_encoding).Service

Sourcetype step = Resto_directory.Make(RPC_encoding).step =

| Static of string
| Dynamic of Resto.Arg.descr
| DynamicTail of Resto.Arg.descr

Possible error while registring services.

Sourcetype conflict = Resto_directory.Make(RPC_encoding).conflict =

| CService of Resto.meth
| CDir
| CBuilder
| CTail
| CTypes of Resto.Arg.descr * Resto.Arg.descr
| CType of Resto.Arg.descr * string list

type ('query, 'input, 'output, 'error) types =
  ('query, 'input, 'output, 'error) Resto_directory.Make(RPC_encoding).types =
  {

query : 'query Resto.Query.t;
input : 'input Service.input;
output : 'output RPC_encoding.t;
error : 'error RPC_encoding.t;

}

Source

type registered_service = Resto_directory.Make(RPC_encoding).registered_service =

| Service : {
1. types : ('q, 'i, 'o, 'e) types;
2. handler : 'q -> 'i -> ('o, 'e) Resto_directory.Answer.t Lwt.t;
} -> registered_service

Sourcetype 'prefix t = 'prefix Resto_directory.Make(RPC_encoding).t

Dispatch tree

Sourcetype 'prefix directory = 'prefix t

Sourcetype lookup_error = [

| `Not_found
| `Method_not_allowed of Resto.meth list
| `Cannot_parse_path of string list * Resto.Arg.descr * string

]

Source

val lookup : 
  'prefix directory ->
  'prefix ->
  Resto.meth ->
  string list ->
  (registered_service, [> lookup_error ]) result Lwt.t

Resolve a service.

Source

val allowed_methods : 
  'prefix directory ->
  'prefix ->
  string list ->
  (Resto.meth list, [> lookup_error ]) result Lwt.t

Source

val transparent_lookup : 
  'prefix directory ->
  ('meth, 'prefix, 'params, 'query, 'input, 'output, 'error) Service.t ->
  'params ->
  'query ->
  'input ->
  [> ('output, 'error) Resto_directory.Answer.t ] Lwt.t

Sourceval empty : 'prefix directory

Empty tree

Sourceval map : ('a -> 'b Lwt.t) -> 'b directory -> 'a directory

Sourceval prefix : ('pr, 'p) Resto.Path.path -> 'p directory -> 'pr directory

Sourceval merge : 'a directory -> 'a directory -> 'a directory

Sourceexception Conflict of step list * conflict

Source

val register_dynamic_directory : 
  ?descr:string ->
  'prefix directory ->
  ('prefix, 'a) Resto.Path.path ->
  ('a -> 'a directory Lwt.t) ->
  'prefix directory

Registring dynamic subtree.

Source

val register_dynamic_directory1 : 
  ?descr:string ->
  'prefix directory ->
  ('prefix, unit * 'a) Resto.Path.path ->
  ('a -> (unit * 'a) directory Lwt.t) ->
  'prefix directory

Registring dynamic subtree. (Curryfied variant)

Source

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

Source

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

Source

val register_describe_directory_service : 
  'prefix directory ->
  ('prefix, 'prefix, 'error) Service.description_service ->
  'prefix directory

Registring a description service.

Source

val describe_directory : 
  recurse:bool ->
  ?arg:'a ->
  'a directory ->
  RPC_encoding.schema Resto.Description.directory Lwt.t

Source

val register : 
  'prefix directory ->
  ([< Resto.meth ], 'prefix, 'p, 'q, 'i, 'o) RPC_service.t ->
  ('p -> 'q -> 'i -> 'o Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
  'prefix directory

Registering handler in service tree.

Source

val register_chunked : 
  'prefix directory ->
  ([< Resto.meth ], 'prefix, 'p, 'q, 'i, 'o) RPC_service.t ->
  ('p -> 'q -> 'i -> 'o Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
  'prefix directory

Source

val opt_register : 
  'prefix directory ->
  ([< Resto.meth ], 'prefix, 'p, 'q, 'i, 'o) RPC_service.t ->
  ('p -> 'q -> 'i -> 'o option Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
  'prefix directory

Source

val gen_register : 
  'prefix directory ->
  ('meth, 'prefix, 'params, 'query, 'input, 'output) RPC_service.t ->
  ('params -> 'query -> 'input -> [< 'output RPC_answer.t ] Lwt.t) ->
  'prefix directory

Source

val lwt_register : 
  'prefix directory ->
  ([< Resto.meth ], 'prefix, 'p, 'q, 'i, 'o) RPC_service.t ->
  ('p -> 'q -> 'i -> 'o Lwt.t) ->
  'prefix directory

Registering handler in service tree. Curryfied variant.

Source

val register0 : 
  unit directory ->
  ('m, unit, unit, 'q, 'i, 'o) RPC_service.t ->
  ('q -> 'i -> 'o Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
  unit directory

Source

val register0_chunked : 
  unit directory ->
  ('m, unit, unit, 'q, 'i, 'o) RPC_service.t ->
  ('q -> 'i -> 'o Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
  unit directory

Source

val register1 : 
  'prefix directory ->
  ('m, 'prefix, unit * 'a, 'q, 'i, 'o) RPC_service.t ->
  ('a -> 'q -> 'i -> 'o Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
  'prefix directory

Source

val register2 : 
  'prefix directory ->
  ('m, 'prefix, (unit * 'a) * 'b, 'q, 'i, 'o) RPC_service.t ->
  ('a -> 'b -> 'q -> 'i -> 'o Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
  'prefix directory

Source

val register3 : 
  'prefix directory ->
  ('m, 'prefix, ((unit * 'a) * 'b) * 'c, 'q, 'i, 'o) RPC_service.t ->
  ('a ->
    'b ->
    'c ->
    'q ->
    'i ->
    'o Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
  'prefix directory

Source

val register4 : 
  'prefix directory ->
  ('m, 'prefix, (((unit * 'a) * 'b) * 'c) * 'd, 'q, 'i, 'o) RPC_service.t ->
  ('a ->
    'b ->
    'c ->
    'd ->
    'q ->
    'i ->
    'o Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
  'prefix directory

Source

val register5 : 
  'prefix directory ->
  ('m, 'prefix, ((((unit * 'a) * 'b) * 'c) * 'd) * 'e, 'q, 'i, 'o)
    RPC_service.t ->
  ('a ->
    'b ->
    'c ->
    'd ->
    'e ->
    'q ->
    'i ->
    'o Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
  'prefix directory

Source

val opt_register0 : 
  unit directory ->
  ('m, unit, unit, 'q, 'i, 'o) RPC_service.t ->
  ('q -> 'i -> 'o option Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
  unit directory

Source

val opt_register1 : 
  'prefix directory ->
  ('m, 'prefix, unit * 'a, 'q, 'i, 'o) RPC_service.t ->
  ('a -> 'q -> 'i -> 'o option Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
  'prefix directory

Source

val opt_register2 : 
  'prefix directory ->
  ('m, 'prefix, (unit * 'a) * 'b, 'q, 'i, 'o) RPC_service.t ->
  ('a ->
    'b ->
    'q ->
    'i ->
    'o option Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
  'prefix directory

Source

val opt_register3 : 
  'prefix directory ->
  ('m, 'prefix, ((unit * 'a) * 'b) * 'c, 'q, 'i, 'o) RPC_service.t ->
  ('a ->
    'b ->
    'c ->
    'q ->
    'i ->
    'o option Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
  'prefix directory

Source

val opt_register4 : 
  'prefix directory ->
  ('m, 'prefix, (((unit * 'a) * 'b) * 'c) * 'd, 'q, 'i, 'o) RPC_service.t ->
  ('a ->
    'b ->
    'c ->
    'd ->
    'q ->
    'i ->
    'o option Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
  'prefix directory

Source

val opt_register5 : 
  'prefix directory ->
  ('m, 'prefix, ((((unit * 'a) * 'b) * 'c) * 'd) * 'e, 'q, 'i, 'o)
    RPC_service.t ->
  ('a ->
    'b ->
    'c ->
    'd ->
    'e ->
    'q ->
    'i ->
    'o option Tezos_error_monad.Error_monad.tzresult Lwt.t) ->
  'prefix directory

Source

val gen_register0 : 
  unit directory ->
  ('m, unit, unit, 'q, 'i, 'o) RPC_service.t ->
  ('q -> 'i -> [< 'o RPC_answer.t ] Lwt.t) ->
  unit directory

Source

val gen_register1 : 
  'prefix directory ->
  ('m, 'prefix, unit * 'a, 'q, 'i, 'o) RPC_service.t ->
  ('a -> 'q -> 'i -> [< 'o RPC_answer.t ] Lwt.t) ->
  'prefix directory

Source

val gen_register2 : 
  'prefix directory ->
  ('m, 'prefix, (unit * 'a) * 'b, 'q, 'i, 'o) RPC_service.t ->
  ('a -> 'b -> 'q -> 'i -> [< 'o RPC_answer.t ] Lwt.t) ->
  'prefix directory

Source

val gen_register3 : 
  'prefix directory ->
  ('m, 'prefix, ((unit * 'a) * 'b) * 'c, 'q, 'i, 'o) RPC_service.t ->
  ('a -> 'b -> 'c -> 'q -> 'i -> [< 'o RPC_answer.t ] Lwt.t) ->
  'prefix directory

Source

val gen_register4 : 
  'prefix directory ->
  ('m, 'prefix, (((unit * 'a) * 'b) * 'c) * 'd, 'q, 'i, 'o) RPC_service.t ->
  ('a -> 'b -> 'c -> 'd -> 'q -> 'i -> [< 'o RPC_answer.t ] Lwt.t) ->
  'prefix directory

Source

val gen_register5 : 
  'prefix directory ->
  ('m, 'prefix, ((((unit * 'a) * 'b) * 'c) * 'd) * 'e, 'q, 'i, 'o)
    RPC_service.t ->
  ('a -> 'b -> 'c -> 'd -> 'e -> 'q -> 'i -> [< 'o RPC_answer.t ] Lwt.t) ->
  'prefix directory

Source

val lwt_register0 : 
  unit directory ->
  ('m, unit, unit, 'q, 'i, 'o) RPC_service.t ->
  ('q -> 'i -> 'o Lwt.t) ->
  unit directory

Source

val lwt_register1 : 
  'prefix directory ->
  ('m, 'prefix, unit * 'a, 'q, 'i, 'o) RPC_service.t ->
  ('a -> 'q -> 'i -> 'o Lwt.t) ->
  'prefix directory

Source

val lwt_register2 : 
  'prefix directory ->
  ('m, 'prefix, (unit * 'a) * 'b, 'q, 'i, 'o) RPC_service.t ->
  ('a -> 'b -> 'q -> 'i -> 'o Lwt.t) ->
  'prefix directory

Source

val lwt_register3 : 
  'prefix directory ->
  ('m, 'prefix, ((unit * 'a) * 'b) * 'c, 'q, 'i, 'o) RPC_service.t ->
  ('a -> 'b -> 'c -> 'q -> 'i -> 'o Lwt.t) ->
  'prefix directory

Source

val lwt_register4 : 
  'prefix directory ->
  ('m, 'prefix, (((unit * 'a) * 'b) * 'c) * 'd, 'q, 'i, 'o) RPC_service.t ->
  ('a -> 'b -> 'c -> 'd -> 'q -> 'i -> 'o Lwt.t) ->
  'prefix directory

Source

val lwt_register5 : 
  'prefix directory ->
  ('m, 'prefix, ((((unit * 'a) * 'b) * 'c) * 'd) * 'e, 'q, 'i, 'o)
    RPC_service.t ->
  ('a -> 'b -> 'c -> 'd -> 'e -> 'q -> 'i -> 'o Lwt.t) ->
  'prefix directory

package tezos-rpc

Module Tezos_rpc.RPC_directorySource

Module `Tezos_rpc.RPC_directory`Source