Module Vcs.Author

Author information as commonly used in Git.

Usually, this is the information of the user who committed a change. The author information contains the user name and email.

For example: Author.v "John Doe <john.doe@mail.com>".

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 of_user_config : user_name:Volgo__.User_name.t -> user_email:Volgo__.User_email.t -> t