package ezresto-directory

  1. Overview
  2. Docs
package ezresto-directory
Legend:
Library
Module
Module type
Parameter
Class
Class type

Directories are sets of services. They are used to spin up servers (see Server) that reply to requests for all their registered services.

module Answer : sig ... end
type step =
  1. | Static of string
  2. | Dynamic of EzResto.Arg.descr
  3. | DynamicTail of EzResto.Arg.descr

Possible error while registring services.

type conflict =
  1. | CService of EzResto.meth
  2. | CDir
  3. | CBuilder
  4. | CTail
  5. | CTypes of EzResto.Arg.descr * EzResto.Arg.descr
  6. | CType of EzResto.Arg.descr * string list
exception Conflict of step list * conflict
type directory

A set of services on which requests can be dispatched.

val empty : directory

Empty tree

val prefix : 'a EzResto.Path.t -> directory -> directory

prefix p d is a directory of services which includes a service registered on the path p / q for each service registered on the path q in d.

  • raises [Invalid_argument]

    if p is a dynamic path.

val merge : directory -> directory -> directory

merge d1 d2 is a directory which includes all the services of d1 and d2.

  • raises [Conflict]

    if one or more service from d1 conflicts with one or more service from d2.

Registered services (with existential types for parameters and such).

type 'input input =
  1. | No_input : unit input
  2. | Input : 'input Json_encoding.encoding -> 'input input
type ('q, 'i, 'o, 'e) types = {
  1. query : 'q Resto.Query.t;
  2. input : 'i input;
  3. output : 'o Json_encoding.encoding;
  4. error : 'e Json_encoding.encoding;
}
type registered_service =
  1. | Service : {
    1. types : ('q, 'i, 'o, 'e) types;
    2. handler : 'q -> 'i -> ('o, 'e) Answer.t Lwt.t;
    } -> registered_service

Resolve a service.

type lookup_error = [
  1. | `Not_found
  2. | `Method_not_allowed of EzResto.meth list
  3. | `Cannot_parse_path of string list * EzResto.Arg.descr * string
]
val lookup : directory -> EzResto.meth -> string list -> (registered_service, [> lookup_error ]) Stdlib.result Lwt.t

lookup d m p is Ok (Service _) if there is a service s registered in d and both the method of s is m and the path of s matches p. It is Error _ otherwise.

If it is Ok (Service _) then the returned value corresponds to the registered service.

val allowed_methods : directory -> string list -> (EzResto.meth list, [> lookup_error ]) Stdlib.result Lwt.t

allowed_methods d p is the set of methods m such that lookup d m p is Ok _. In other words, it is the set of methods m such that a service has been registered in d for a path that matches p.

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

Registering a handler to a service in a directory.

val register : directory -> ('meth, 'params, 'query, 'input, 'output, 'error) EzResto.service -> ('params -> 'query -> 'input -> ('output, 'error) Answer.t Lwt.t) -> directory

register d s h is a directory that contains all the services registered in d plus the service s. Requests to the service s are handled by the handler h.

Below are variants of the register function curryfied for specific arity of services.

val register0 : directory -> ('meth, unit, 'q, 'i, 'o, 'e) EzResto.service -> ('q -> 'i -> ('o, 'e) Answer.t Lwt.t) -> directory
val register1 : directory -> ('meth, unit * 'a, 'q, 'i, 'o, 'e) EzResto.service -> ('a -> 'q -> 'i -> ('o, 'e) Answer.t Lwt.t) -> directory
val register2 : directory -> ('meth, (unit * 'a) * 'b, 'q, 'i, 'o, 'e) EzResto.service -> ('a -> 'b -> 'q -> 'i -> ('o, 'e) Answer.t Lwt.t) -> directory
val register3 : directory -> ('meth, ((unit * 'a) * 'b) * 'c, 'q, 'i, 'o, 'e) EzResto.service -> ('a -> 'b -> 'c -> 'q -> 'i -> ('o, 'e) Answer.t Lwt.t) -> directory
val register4 : directory -> ('meth, (((unit * 'a) * 'b) * 'c) * 'd, 'q, 'i, 'o, 'e) EzResto.service -> ('a -> 'b -> 'c -> 'd -> 'q -> 'i -> ('o, 'e) Answer.t Lwt.t) -> directory
val register5 : directory -> ('meth, ((((unit * 'a) * 'b) * 'c) * 'd) * 'e, 'q, 'i, 'o, 'e) EzResto.service -> ('a -> 'b -> 'c -> 'd -> 'e -> 'q -> 'i -> ('o, 'e) Answer.t Lwt.t) -> directory
val register_dynamic_directory : ?descr:string -> directory -> 'params EzResto.Path.t -> ('params -> directory Lwt.t) -> directory

Registring dynamic subtree.

val register_dynamic_directory1 : ?descr:string -> directory -> (unit * 'a) EzResto.Path.t -> ('a -> directory Lwt.t) -> directory

Registring dynamic subtree. (Curryfied variant)

val register_dynamic_directory2 : ?descr:string -> directory -> ((unit * 'a) * 'b) EzResto.Path.t -> ('a -> 'b -> directory Lwt.t) -> directory
val register_dynamic_directory3 : ?descr:string -> directory -> (((unit * 'a) * 'b) * 'c) EzResto.Path.t -> ('a -> 'b -> 'c -> directory Lwt.t) -> directory
val register_describe_directory_service : directory -> EzResto.description_service -> directory

Registring a description service.