package ez_api

  1. Overview
  2. Docs
Easy API library and tools

Install 

dune-project
 Dependency

github.com Readme Changelog LGPL-2.1-only WITH OCaml-LGPL-linking-exception License Edit opam file Versions (6)

Authors

  1. C
    Cagdas Bozman <cagdas.bozman@ocamlpro.com>
  2. M
    Michael Laporte <michael.laporte@ocamlpro.com>
  3. F
    Fabrice Le Fessant <fabrice.le_fessant@ocamlpro.com>
  4. M
    Maxime Levillain <maxime.levillain@ocamlpro.com>
  5. A
    Alain Mebsout <alain.mebsout@ocamlpro.com>

Maintainers

  1. F
    Fabrice Le Fessant <fabrice.le_fessant@ocamlpro.com>

Sources

1.1.1.tar.gz
md5=65d5fef737c82120d579d10a1727b8e4
sha512=2ea5c072d5a4c264263264cfd485eadae2bd7f47949dbc9cb4cf93db89640d91542463ed8b9f4d6679f21bbd1efbfa6c224ff36f1807a8d8af9d0568cf8a4292

doc/ez_api.server_utils/EzAPIServerUtils/Directory/index.html

Module EzAPIServerUtils.DirectorySource

Sourcemodule StringMap : sig ... end
Sourcemodule MethMap : sig ... end
Sourcemodule Step : sig ... end
Sourcetype conflict =
  1. | CService of EzAPI.Meth.t
  2. | CTypes of EzAPI.Arg.descr * EzAPI.Arg.descr
Sourceand 'a directory = {
  1. services : 'a registered_service MethMap.t;
  2. subdirs : 'a static_subdirectories option * 'a variable_subdirectories option;
}
Sourceand 'a static_subdirectories = 'a directory StringMap.t
Sourceand _ variable_subdirectories =
  1. | Arg : 'a1 EzAPI.Arg.t * ('a * 'a1) directory -> 'a variable_subdirectories
Sourceand _ registered_service =
  1. | Http : {
    1. service : ('a, 'i, 'o, 'e, 's) EzAPI.Service.t;
    2. handler : 'a -> 'i -> ('o, 'e) result Answer.t Lwt.t;
    } -> 'a registered_service
  2. | Websocket : {
    1. service : ('a, 'i, 'o, 'e, 's) EzAPI.Service.t;
    2. react : 'a -> 'i -> ('o, 'e) result Lwt.t;
    3. bg : 'a -> (('o, 'e) result -> unit) -> unit Lwt.t;
    4. onclose : ('a -> unit Lwt.t) option;
    5. step : float option;
    } -> 'a registered_service
Sourceval empty : 'a directory
Sourcetype resolved_directory =
  1. | Dir : 'a directory * 'a -> resolved_directory
Sourcetype lookup_error = [
  1. | `Not_found
  2. | `Cannot_parse of EzAPI.Arg.descr * string * string list
  3. | `Method_not_allowed
]
Sourcetype handler_error = [
  1. | EzEncoding.destruct_error
  2. | `unsupported of string option
  3. | `handler_exn of exn
  4. | `handler_error of string
]
Sourcetype ws_frame = [
  1. | `binary of string
  2. | `text of string
  3. | `none
]
Sourcetype lookup_ok = [
  1. | `head
  2. | `options of (string * string) list
  3. | `http of string -> (string Answer.t, handler_error) result Lwt.t
  4. | `ws of (string -> (ws_frame, handler_error) result Lwt.t) * (((ws_frame, handler_error) result -> unit) -> unit Lwt.t) * (unit -> unit Lwt.t) option * float option
]
Sourceval conflict_to_string : conflict -> string
Sourceval resolve : 'a. string list -> 'a directory -> 'a -> string list -> (resolved_directory, lookup_error) result Lwt.t
Sourceval io_to_answer : 'a. code:int -> 'a EzAPI.io -> 'a -> string Answer.t
Sourceval ser_handler : 'i 'o 'e. ?content_type:string -> ('a -> 'i -> ('o, 'e) result Answer.t Lwt.t) -> 'a -> 'i EzAPI.io -> 'o EzAPI.io -> 'e Json_encoding.encoding -> string -> (string Answer.t, handler_error) result Lwt.t
Sourceval io_to_ws_frame : 'a. 'a EzAPI.io -> 'a -> ws_frame
Sourceval ser_websocket : ('a -> 'b -> ('c, 'd) result Lwt.t) -> ('a -> (('c, 'd) result -> 'e) -> 'f) -> 'a -> 'b EzAPI.IO.io -> 'c EzAPI.io -> 'd Json_encoding.encoding -> (string -> (ws_frame, [> `cannot_destruct of string * string | `handler_error of string | `handler_exn of exn | `unexpected_field of string ]) Result.result Lwt.t) * (((ws_frame, [> `handler_error of string ]) result -> 'e) -> 'f)
Sourceval lookup : ?meth:[< `DELETE | `GET | `HEAD | `OPTIONS | `PATCH | `POST | `PUT ] -> ?content_type:string -> 'a directory -> 'a -> string list -> (lookup_ok, lookup_error) result Lwt.t
Sourceval step_of_path : ('a, 'b) EzAPI.Path.t -> Step.t list
Sourceval conflict : ('a, 'b) EzAPI.Path.t -> 'c -> ('d, Step.t list * 'c) result
Sourceval insert : 'r 'a. ('r, 'a) EzAPI.Path.t -> 'r directory -> ('a directory * ('a directory -> 'r directory), Step.t list * conflict) result
Sourceval register : 'a. t -> ('a, 'b, 'c, 'd, [< EzAPI.Security.scheme ] as 'e) EzAPI.Service.t -> (('a, 'b, 'c, 'd, 'e) EzAPI.Service.t -> 'a registered_service) -> (t, Step.t list * conflict) result
Sourceval register_http : t -> ('a, 'b, 'c, 'd, [< EzAPI.Security.scheme ]) EzAPI.Service.t -> ('a -> 'b -> ('c, 'd) result Answer.t Lwt.t) -> (t, Step.t list * conflict) result
Sourceval register_ws : t -> ?onclose:('a -> unit Lwt.t) -> ?step:float -> react:('a -> 'b -> ('c, 'd) result Lwt.t) -> bg:('a -> (('c, 'd) result -> unit) -> unit Lwt.t) -> ('a, 'b, 'c, 'd, [< EzAPI.Security.scheme ]) EzAPI.Service.t -> (t, Step.t list * conflict) result