package batteries

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

Install

Dune Dependency

Authors

Maintainers

Sources

v3.6.0.tar.gz
md5=1bcb27dfbd130eb057561196ef851649
sha512=2a56611b09a5f1cba6457539f8b6bc87a5f2a5454b36cdb39f6e0d6a5dac6db179aab1ba87c74dd49cc41df31a9a96feb349028ea41df7371ecb47f4d9dfafc4

doc/batteries.unthreaded/BatPathGen/OfString/Operators/index.html

Module OfString.Operators

Infix operators for path construction. They are in separate module, so one can open Path.Operators to use them.

@documents Future.Path.Operators

val (/:) : t -> ustring -> t

path/:name is a path of name located in a directory path. For example:

  • PathType.root/:"var"/:"log" builds absolute path "/var/log"
  • [user]/:".ssh" can be either:

    • absolute path "/.ssh" in case user is an empty string
    • relative path otherwise

PathType.default_validator is applied to the argument. name must not contain path separator (causes Illegal_char exception).

  • raises Illegal_char

    (raised by validator on any bad character)

val (//@) : t -> t -> t

basepath//\@relpath catenates two paths.

Windows: As a special exception it is possible to pass absolute path as relpath, provided that basepath is simple absolute path (i.e. of the form [...; ""]) and relpath is not simple absolute path.

  • raises Invalid_argument

    if the second argument is an absolute path (Windows: see above).

OCaml

Innovation. Community. Security.