package batteries

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

Install

dune-project
 Dependency

Authors

Maintainers

Sources

batteries-3.10.0.tar.gz
md5=b7f3b99f12f21b1da6b6aa13d993206d
sha512=8b7f2479eb0271bcfd9168887c1e4a9a815c512eab3ee61b150fc4dfa9ec803e4f73115155f20b3017e4a822148d0e6d1c1e8e5f96790fd691b419dd39a908a2

doc/batteries.unthreaded/BatPathGen/index.html

Module BatPathGenSource

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

Sourcemodule type StringType = sig ... end

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

Sourcemodule type PathType = sig ... end

All implementations of Path functionality have this module type.

Sourcemodule 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.

Sourcemodule 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.