package file_path

  1. Overview
  2. Docs
package file_path
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module File_path.OperatorsSource

Prefix operators: conversions

These use two characters indicating the type of path: 1. absolute, relative, or either 2. compound or single-part

If constructing a path, that is all.

If consuming a path, they use a third character indicating the return type.

of_string synonyms: just indicate the path type being constructed

Sourceval (~/) : string -> Types.Relative.t
Sourceval (!/) : string -> Types.Absolute.t
Sourceval (?/) : string -> Types.Path.t
Sourceval (~.) : string -> Types.Part.t

to_string synonyms: end in '$' for a string return type

Sourceval (~/$) : Types.Relative.t -> string
Sourceval (!/$) : Types.Absolute.t -> string
Sourceval (?/$) : Types.Path.t -> string
Sourceval (~.$) : Types.Part.t -> string

Up-conversions: end in '?' or '~' to indicate return type

Infix operators: append* synonyms

These use three characters: 1. '/' indicating some kind of path concatenation 2. type of left argument and result 3. type of right argument and kind of concatenation

These operators are left-associative and all share the same precedence.

append synonyms: end in '/' for a compound right argument

append_part synonyms: end in '.' for a single-part right argument

append_to_basename_exn synonyms: end in '^' for string concatenation

Sourceval (/~^) : Types.Relative.t -> string -> Types.Relative.t
Sourceval (/!^) : Types.Absolute.t -> string -> Types.Absolute.t
Sourceval (/?^) : Types.Path.t -> string -> Types.Path.t
Sourceval (/.^) : Types.Part.t -> string -> Types.Part.t
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct