Module Filepath.Normalized

module Normalized: sig .. end

The Normalized module is simply a wrapper that ensures that paths are always normalized. Used by Datatype.Filepath.


type t = private string 

The normalized (absolute) path.

val of_string : ?base_name:string -> string -> t

of_string s converts s into a normalized path.

val to_pretty_string : t -> string

to_pretty_string p returns p prettified, that is, a relative path-like string. Note that this prettified string may contain symbolic dirs and is thus is not a path. See pretty for details about usage.

val equal : t -> t -> bool
val compare : t -> t -> int

Compares normalized paths

val compare_pretty : ?case_sensitive:bool -> t -> t -> int

Compares prettified (i.e. relative) paths, with or without case sensitivity (by default, case_sensitive = false).

val pretty : Stdlib.Format.formatter -> t -> unit

Pretty-print a path according to these rules:

val pp_abs : Stdlib.Format.formatter -> t -> unit

Pretty-prints the normalized (absolute) path.

val unknown : t

Unknown filepath, used as 'dummy' for Datatype.Filepath.