package mustache

  1. Overview
  2. Docs
Mustache logic-less templates in OCaml

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (6)

Authors

  1. R
    Rudi Grinberg
  2. A
    Armaël Guéneau

Maintainers

  1. R
    rudi.grinberg@gmail.com

Sources

v3.1.0.zip
sha256=8b0a04af0cb897fdba41fd946fa1b6cdb3982ca0db604e13ee0977585ff4c45d
md5=ee15623d0f699b6aff31904fedf4945e

doc/mustache/Mustache/index.html

Module MustacheSource

Sourceexception Invalid_param of string

A module for creating and rendering mustache templates in OCaml.

Sourceexception Invalid_template of string
Sourceexception Missing_variable of string

Raised when a missing variable in a template is not substituted

Sourceexception Missing_section of string
Sourceexception Missing_partial of string
Sourcemodule Json : sig ... end
Sourcetype name = string
Sourcetype dotted_name = string list
Sourcetype t =
  1. | String of string
  2. | Escaped of dotted_name
  3. | Section of section
  4. | Unescaped of dotted_name
  5. | Partial of partial
  6. | Inverted_section of section
  7. | Concat of t list
  8. | Comment of string
Sourceand section = {
  1. name : dotted_name;
  2. contents : t;
}
Sourceand partial = {
  1. indent : int;
  2. name : name;
  3. contents : t option Lazy.t;
}
Sourceval parse_lx : Lexing.lexbuf -> t

Read

Sourceval of_string : string -> t
Sourceval pp : Format.formatter -> t -> unit

pp fmt template print a template as raw mustache to the formatter fmt.

Sourceval to_formatter : Format.formatter -> t -> unit

Alias for compatibility

Sourceval to_string : t -> string

to_string template uses to_formatter in order to return a string representing the template as raw mustache.

Sourceval render_fmt : ?strict:bool -> ?partials:(name -> t option) -> Format.formatter -> t -> Json.t -> unit

render_fmt fmt template json render template, filling it with data from json, printing it to formatter fmt.

For each partial p, if partials p is Some t then the partial is substituted by t. Otherwise, the partial is substituted by the empty string is strict is false. If strict is true, the Missing_partial exception is raised.

Sourceval render : ?strict:bool -> ?partials:(name -> t option) -> t -> Json.t -> string

render template json use render_fmt to render template with data from json and returns the resulting string.

Sourceval fold : string:(string -> 'a) -> section:(inverted:bool -> dotted_name -> 'a -> 'a) -> escaped:(dotted_name -> 'a) -> unescaped:(dotted_name -> 'a) -> partial:(int -> name -> t option Lazy.t -> 'a) -> comment:(string -> 'a) -> concat:('a list -> 'a) -> t -> 'a

fold template is the composition of f over parts of template, called in order of occurrence, where each f is one of the labelled arguments applied to the corresponding part. The default for f is the identity function.

  • parameter string

    Applied to each literal part of the template.

  • parameter escaped

    Applied to "name" for occurrences of {{name}}.

  • parameter unescaped

    Applied to "name" for occurrences of {{{name}}}.

  • parameter partial

    Applied to "box" for occurrences of {{> box}}.

  • parameter comment

    Applied to "comment" for occurrences of {{! comment}}.

Sourceval expand_partials : (name -> t option) -> t -> t

expand_partials f template is template where for each Partial p node, p.contents now evaluates to f p.name if they were evaluating to None. Note that no lazy is forced at this point, and calls to f are delayed until p.contents is forced.

Sourcemodule Infix : sig ... end

Shortcut for concatening two templates pieces.

Sourceval escape_html : string -> string

Escape &, "\"", ', < and > character for html rendering.

Sourceval raw : string -> t

<p>This is raw text.</p>

Sourceval escaped : dotted_name -> t

{{name}}

Sourceval unescaped : dotted_name -> t

{{{name}}}

Sourceval inverted_section : dotted_name -> t -> t

{{^person}} {{/person}}

Sourceval section : dotted_name -> t -> t

{{#person}} {{/person}}

Sourceval partial : ?indent:int -> name -> t option Lazy.t -> t

{{> box}}

Sourceval comment : string -> t

{{! this is a comment}}

Sourceval concat : t list -> t

Group a t list as a single t.

Sourcemodule With_locations : sig ... end

Variant of the t mustache datatype which includes source-file locations, and associated functions.

Sourceval erase_locs : With_locations.t -> t

Erase locations from a mustache value of type With_locations.t.

Sourceval add_dummy_locs : t -> With_locations.t

Add the dummy_loc location to each node of a mustache value of type t.