package volgo

  1. Overview
  2. Docs

Module Vcs.Repo_rootSource

The root of a version control repository that is expected to exists on the local file system.

This is a wrapper around Absolute_path.t to increase type safety.

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

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

Sourceval of_string : string -> (t, [ `Msg of string ]) 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.

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

Sourceval of_absolute_path : Fpath_sexp0.Absolute_path.t -> t
Sourceval to_absolute_path : t -> Fpath_sexp0.Absolute_path.t
Sourceval relativize : t -> Fpath_sexp0.Absolute_path.t -> Path_in_repo.t option

Given an absolute path that is under this repository, returns its relative repo path. This returns None if the supplied absolute path doesn't point to a path within this repository.

This is useful to access file on the file system.