package ocp-ocamlres

You can search for identifiers within the package.

in-package search v0.2.0

ocplib-ocamlres
- OCamlRes
  - Path
  - Res
- OCamlResFormats
  - Files
    
    SF
  - Format
  - OCaml
    
    SF
  - Res
    
    SF
- OCamlResRegistry
  - ExtensionDispatcherSubFormat
  - Files
    
    F
  - Format
  - Int
  - Lines
  - OCaml
    
    F
  - PredefOptions
  - Raw
  - Res
    
    F
  - SM
  - SubFormat
- OCamlResScanners
  - PathFilter
  - ResFilter
- OCamlResSubFormats
  - Int
  - Lines
  - Raw
  - SubFormat

Legend:
Library
Module
Module type
Parameter
Class
Class type

Formatters for the main resource tree structure

module type Format = sig ... end

Format modules essentially wrap an output function which takes a resource tree as input and produces an output.

module OCaml (SF : OCamlResSubFormats.SubFormat) : sig ... end

This format produces OCaml source code with OCaml submodules for directories and OCaml value definitions for files. It is parametric in the type of leaves and the pretty printing function. It is used by the command line tool as instanciated in OCamlResRegistry.

module Res (SF : OCamlResSubFormats.SubFormat) : sig ... end

Produces OCaml source contaiming a single root value which contains an OCamlRes tree to be used at runtime through the OCamlRes module.

module Files (SF : OCamlResSubFormats.SubFormat) : sig ... end

Reproduces the original scanned files (or creates new ones in case of a forged resource store).