package ez_api

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Parameters
Signature

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.blake2s
- EzHash
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.sha2
- EzHash
ez_api.sha3
- EzHash
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

User storage located in the memory of the server.

Parameters

module S : EzSession.TYPES.SessionArg with type user_id = string

Signature

val create_user : 
  ?pwhash:Stdlib.Digest.t ->
  ?password:string ->
  ?kind:string ->
  login:string ->
  S.user_info ->
  unit

Creates user and adds it to users. If kind is specified, than creates user without password (foreign user). User id corresponds to login. Hash password if pwhash is not specified. Raises UserAlreadyDefined if a user with the same login already exists. Raises NoPasswordProvided if no pwhash or password was specified for a local (non foreign) user.

val remove_user : login:string -> unit

Removes user with the given login from the storage

val find_user : 
  login:string ->
  (string option * S.user_id * S.user_info) option Lwt.t

Searches for user with given login and returns its password, if defined, its id and its information.

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

Checks for foreign user with the login origin-token. If exists, returns its login. Otherwise returns an error number with an error message.

val register_foreign : 
  origin:string ->
  token:string ->
  (S.user_id * S.user_info option, int * string option) Stdlib.result Lwt.t

See default_register_foreign (not implemented yet).

module SessionArg : 
  EzSession.TYPES.SessionArg
    with type user_info = S.user_info
     and type user_id = S.user_id

See EzSession.TYPES.SessionArg

module SessionStore : SessionStore with type user_id = S.user_id

See SessionStore