package batteries

  1. Overview
  2. Docs
A community-maintained standard library extension

Install 

dune-project
 Dependency

github.com Edit opam file Versions (15)

Authors

  1. O
    OCaml batteries-included team

Maintainers

  1. C
    Cedric Cellier <rixed@happyleptic.org>
  2. F
    Francois Berenger <unixjunkie@sdf.org>
  3. Gabriel Scherer
  4. T
    Thibault Suzanne <thi.suzanne@gmail.com>

Sources

v3.3.0.tar.gz
sha256=40d18485911e343500a5636bbf1d84e2ee32f924fe87e5fd13a37641a4d8f226
md5=fe4da12b678a82faaeda4e58492ea871

doc/batteries.unthreaded/BatPathGen/index.html

Module BatPathGen

Filepath handling.

Paths can be used with different string implementations:

  • see Path.OfRope to use paths built of validated UTF-8 strings (Rope.t)
  • see Path.OfString to use paths based on primitive string type. Actual strings may use UTF-8 encoding.
  • author Dawid Toton
Functorized interface
module type StringType = sig ... end

This signature lists few basic operations provided by all string types.

module type PathType = sig ... end

All implementations of Path functionality have this module type.

module Make (S : StringType) : PathType with type ustring = S.t and type uchar = S.tchar

Constructs path handling module for string-like type and its operations given in S.

module OfString : PathType with type ustring = string and type uchar = char

This implementation can be used with UTF-8, but encoding of used strings is not verified.