package ez_api

You can search for identifiers within the package.

in-package search v0.2.0

package ez_api

ez_api
- EzAPI
  - Arg
    
    Ty
    
    Ty
  - Doc
  - Err
    
    IntMap
  - Error_codes
  - Legacy
  - Meth
  - Mime
  - Param
  - Path
  - Req
    
    StringMap
  - Security
    
    StringSet
  - Service
    
    IO
  - TYPES
  - Url
    
    TYPES
ez_api.cohttp
- EzCohttp
  - Base
  - Interface
  - Legacy
ez_api.cohttp_base
- EzCohttp_base
  - Make
    
    Client
ez_api.cohttp_lwt
- EzCohttp_lwt
  - Base
  - Interface
  - Legacy
ez_api.debug_unix
- EzDebug
ez_api.encoding
- EzEncoding
  - Ezjsonm
ez_api.ezjsonm_unix
- Ezjsonm_interface
ez_api.facebook_auth
- Facebook
  - Encoding
  - Services
  - Types
ez_api.google_auth
- Google
  - Encoding
  - Services
  - Types
ez_api.icohttp
- EzReq
  - Interface
  - Legacy
ez_api.icohttp_lwt
- EzReq_lwt
  - Interface
  - Legacy
ez_api.iserver_cohttp
- EzServer
ez_api.iserver_default
- EzServer
ez_api.loads_offset
- EzLoads_offset
ez_api.lwt_unix
- EzLwtSys
ez_api.md5
- EzHash
ez_api.openAPI
- EzOpenAPI
  - Encoding
  - Makers
  - Types
ez_api.ppx_common
- Ppx_common
ez_api.req_default
- EzReq
  - Interface
  - Legacy
ez_api.req_lwt_default
- EzReq_lwt
  - Interface
  - Legacy
ez_api.request
- EzRequest
  - ANY
    
    Legacy
  - Make
    
    Legacy
    
    _
ez_api.request_lwt
- EzRequest_lwt
  - ANY
    
    Legacy
  - Make
    
    Legacy
    
    _
ez_api.request_verbose
- Verbose
ez_api.sendgrid_encoding
- EzSendgrid_encoding
- EzSendgrid_types
ez_api.sendgrid_services
- EzSendgrid_services
ez_api.server
- EzAPIServer
ez_api.server_cohttp
- EzAPIServerCohttp
ez_api.server_session
- EzCookieServer
- EzSessionServer
  - Arg
    
    SessionArg
    
    SessionStore
  - Make
    
    S
    
    SessionArg
    
    SessionStore
    
    Service
  - SessionStore
  - SessionStoreInMemory
  - UserStoreInMemory
    
    S
    
    SessionArg
    
    SessionStore
ez_api.server_utils
- EzAPIServerUtils
  - Answer
  - Directory
    
    MethMap
    
    Step
    
    StringMap
  - File
    
    FileString
  - GMTime
  - Ip
  - Legacy
  - StringMap
  - Timings
ez_api.session
- EzSession
  - Hash
  - M
  - Make
    
    Encoding
    
    S
    
    Service
  - TYPES
    
    SessionArg
ez_api.session_client
- EzSessionClient
  - Make
    
    S
    
    Service
    
    _
    
    Legacy
ez_api.ws_server_cohttp
- WsCohttp
ez_api.ws_server_httpaf
- WsHttpaf
ez_api.ws_types
- EzWsCommon
  - S
  - Types

Legend:
Library
Module
Module type
Parameter
Class
Class type

val random_challenge : unit -> string

Returns random challenge 30 characters long

module type SessionStore = sig ... end

Module that defines a way to store user's sessions.

module type Arg = sig ... end

Main argument for Make functor. Specifies session's and user's storage and session main configurations.

val default_check_foreign : 
  origin:string ->
  token:string ->
  (_, int * string option) Stdlib.result Lwt.t

Not implemented search for foreign user.

val default_register_foreign : 
  origin:string ->
  token:string ->
  (_, int * string option) Stdlib.result Lwt.t

Not implemented registration for foreign user.

module Make (S : Arg) : sig ... end

Main functor that defines handlers for authentication services.

exception UserAlreadyDefined

Exception when trying to create user that already exists.

exception NoPasswordProvided

Exception when trying to create non-foreign user without password.

module UserStoreInMemory
  (S : EzSession.TYPES.SessionArg with type user_id = string) : 
  sig ... end

User storage located in the memory of the server.

module SessionStoreInMemory : SessionStore

Implementation of session store in the server's memory.