Module `EzAPIServerUtils.Directory`Source

Sourcemodule StringMap : sig ... end

Sourcemodule MethMap : sig ... end

Sourcemodule Step : sig ... end

Sourcetype conflict =

| CService of EzAPI.Meth.t
| CTypes of EzAPI.Arg.descr * EzAPI.Arg.descr

Sourceand 'a directory = {

services : 'a registered_service MethMap.t;
subdirs : 'a static_subdirectories option * 'a variable_subdirectories option;

}

Sourceand 'a static_subdirectories = 'a directory StringMap.t

Sourceand _ variable_subdirectories =

| Arg : 'a1 EzAPI.Arg.t * ('a * 'a1) directory -> 'a variable_subdirectories

Sourceand _ registered_service =

| 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
| 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 t = EzAPI.Req.t directory

Sourcetype resolved_directory =

| Dir : 'a directory * 'a -> resolved_directory

Sourcetype lookup_error = [

| `Not_found
| `Cannot_parse of EzAPI.Arg.descr * string * string list
| `Method_not_allowed

]

Sourcetype handler_error = [

| EzEncoding.destruct_error
| `unsupported of string option
| `handler_exn of exn
| `handler_error of string

]

Sourcetype ws_frame = [

| `binary of string
| `text of string
| `none

]

Sourcetype lookup_ok = [

| `head
| `options of (string * string) list
| `http of string -> (string Answer.t, handler_error) result Lwt.t
| `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

Source

val resolve : 
  'a. string list ->
  'a directory ->
  'a ->
  string list ->
  (resolved_directory, lookup_error) result Lwt.t

Source

val io_to_answer : 
  'a. code:int ->
  headers:(string * string) list ->
  'a EzAPI.io ->
  'a ->
  string Answer.t

Source

val ser_handler : 
  'i 'o 'e. ?content_type:string ->
  access_control:(string * string) list ->
  ('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

Source

val 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,
    [> `destruct_exn of exn | `handler_error of string | `handler_exn of exn ])
    result
    Lwt.t)
  * (((ws_frame, [> `handler_error of string ]) result -> 'e) ->
  'f)

Source

val 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

Source

val insert : 
  'r 'a. ('r, 'a) EzAPI.Path.t ->
  'r directory ->
  ('a directory * ('a directory -> 'r directory), Step.t list * conflict)
    result

Source

val 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

Source

val 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

Source

val 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

Install

Dune Dependency

Authors

Maintainers

Sources

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

Module `EzAPIServerUtils.Directory`Source

package ez_api

Install

Dune Dependency

Authors

Maintainers

Sources

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

Module EzAPIServerUtils.DirectorySource

Module `EzAPIServerUtils.Directory`Source