package ocp-ocamlres

You can search for identifiers within the package.

in-package search v0.2.0

ocp-ocamlres
- Library ocplib-ocamlres
  - OCamlResFormats
    
    Format
    
    OCaml
    
    Res
    
    Files
  - OCamlResRegistry
    
    Format
    
    SubFormat
    
    Raw
    
    Int
    
    Lines
    
    PredefOptions
    
    ExtensionDispatcherSubFormat
    
    OCaml
    
    Res
    
    Variants
    
    Files
  - OCamlResScanners
    
    PathFilter
    
    ResFilter
  - OCamlResSubFormats
    
    SubFormat
    
    Int
    
    Raw
    
    Lines
- Sources
  - ocplib-ocamlres
    
    oCamlResFormats.ml
    
    oCamlResRegistry.ml
    
    oCamlResScanners.ml
    
    oCamlResSubFormats.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `OCamlResSubFormats.Raw`Source

The default format (raw contents as a string)

Sourcetype t = string

The generation-time intermediate representation of data.

Sourceval from_raw : OCamlRes.Path.t -> string -> t

A parser as used by the scanner to obtain the in-memory resources from files.

Sourceval to_raw : OCamlRes.Path.t -> t -> string

A dumper to reconstitute the files from the in-memory resources.

Sourceval pprint : OCamlRes.Path.t -> t -> PPrint.document

Takes the path to the resource in the resource tree, and its value to pretty print. Returns the OCaml representation of the value.

Sourceval pprint_header : OCamlRes.Path.t -> t -> PPrint.document option

Provides an optional piece of OCaml code to put before the resource store definition, for instance a type definition.

Sourceval pprint_footer : OCamlRes.Path.t -> t -> PPrint.document option

Provides an optional piece of OCaml code to put after the resource store definition, for instance a type definition.

Sourceval name : OCamlRes.Path.t -> t -> string

A name used to identify the subformat.

Sourceval type_name : OCamlRes.Path.t -> t -> string

The run-time OCaml type name (that describes the type of values generated by pprint). Used to annotate the generated source where needed. The common usecase is when this function returns the same type as the static t type.

Sourceval mod_name : OCamlRes.Path.t -> t -> string

The name of the subformat module at run-time. If the static type t is the same as the runtime type returned by type_abbrv, this is simply the path to the module used for generation.

package ocp-ocamlres

Module OCamlResSubFormats.RawSource

Module `OCamlResSubFormats.Raw`Source