package volgo

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

Module Vcs.Path_in_repoSource

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.

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 -> Volgo_stdlib.Sexp.t
Sourceval to_dyn : t -> Volgo_stdlib.Dyn.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 ]) Volgo_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.

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 root : t
Sourceval to_fpath : t -> Fpath_sexp0.Fpath.t
Sourceval to_relative_path : t -> Volgo_stdlib.Relative_path.t
Sourceval of_relative_path : Volgo_stdlib.Relative_path.t -> t