package current_web

You can search for identifiers within the package.

in-package search v0.2.0

package current_web

current_web
- Current_web
  - Context
  - Resource
    
    t
  - Role
  - Site
    
    raw_resource
  - User

Legend:
Library
Module
Module type
Parameter
Class
Class type

type t

The context of a single web request.

val of_request : site:Site.t -> Cohttp.Request.t -> t Lwt.t

val request : t -> Cohttp.Request.t

val csrf : t -> string

csrf t is the user's CSRF token to include in POST forms.

val set_user : t -> User.t -> (Cohttp.Response.t * Cohttp_lwt.Body.t) Lwt.t

set_user t user records a successful login by user and redirects the user back to the page they came from.

val respond_ok : 
  t ->
  ?refresh:int ->
  [< Html_types.div_content_fun ] Tyxml.Html.elt list ->
  (Cohttp.Response.t * Cohttp_lwt.Body.t) Lwt.t

respond_ok ctx refresh content returns a successful page with content inserted into the site template. If refresh is Some s, the page is refreshed every s seconds.

val respond_redirect : 
  t ->
  Uri.t ->
  (Cohttp.Response.t * Cohttp_lwt.Body.t) Lwt.t

respond_redirect ctx uri redirects the user to uri.

val respond_error : 
  t ->
  Cohttp.Code.status_code ->
  string ->
  (Cohttp.Response.t * Cohttp_lwt.Body.t) Lwt.t

respond_error ctx code msg returns an error message to the user, inside the site template.