Module Vcs.Path_in_repo

A path for a file versioned in a repository.

This is a wrapper for a Fpath.t relative to the repo root, used for accrued type safety.

type t
val compare : t -> t -> int
val equal : t -> t -> bool
val hash : t -> int
val seeded_hash : int -> t -> int
val sexp_of_t : t -> Sexplib0.Sexp.t
val to_string : t -> string

Given that t = string in the implementation, this function is just the identity.

val of_string : string -> (t, [ `Msg of string ]) Stdlib.Result.t

of_string str returns Ok str if X.invariant str = true, and an error otherwise. This is meant to be used to validate untrusted entries.

val v : string -> t

v str is a convenient wrapper to build a t or raise Invalid_argument. This is typically handy for applying on trusted literals.

val root : t
val to_fpath : t -> Fpath_sexp0.Fpath.t
val to_relative_path : t -> Fpath_sexp0.Relative_path.t
val of_relative_path : Fpath_sexp0.Relative_path.t -> t