Module Vcs.Trait

The traits that Vcs depends on to implement its functionality.

Vcs is parametrized by a list of specific interfaces and classes that constitute the low level operations needed by Vcs. We call them traits.

The intended usage for a library that requires Vcs functionality is to specify via the type of the vcs value, the exact list of traits required. Doing this in this way, allows for flexibility, as any backend supplying that list of traits or more will be compatible as a backend to be supplied to your code.

For example, consider a function that needs to list all the files under version control, and show their contents at some revision. Such functionality will require:

  val my_vcs_function
    : vcs : < Vcs.Trait.ls_files ; Vcs.Trait.show ; .. > Vcs.t
    -> ..
    -> ..
class type add = Volgo__.Trait_add.t
module Add : sig ... end
class type branch = Volgo__.Trait_branch.t
module Branch : sig ... end
class type commit = Volgo__.Trait_commit.t
module Commit : sig ... end
class type config = Volgo__.Trait_config.t
module Config : sig ... end
class type current_branch = Volgo__.Trait_current_branch.t
module Current_branch : sig ... end
class type current_revision = Volgo__.Trait_current_revision.t
module Current_revision : sig ... end
class type file_system = Volgo__.Trait_file_system.t
module File_system : sig ... end
class type git = Volgo__.Trait_git.t
module Git : sig ... end
class type hg = Volgo__.Trait_hg.t
module Hg : sig ... end
class type init = Volgo__.Trait_init.t
module Init : sig ... end
class type log = Volgo__.Trait_log.t
module Log : sig ... end
class type ls_files = Volgo__.Trait_ls_files.t
module Ls_files : sig ... end
class type name_status = Volgo__.Trait_name_status.t
module Name_status : sig ... end
class type num_status = Volgo__.Trait_num_status.t
module Num_status : sig ... end
class type refs = Volgo__.Trait_refs.t
module Refs : sig ... end
class type show = Volgo__.Trait_show.t
module Show : sig ... end
class type t = object ... end

The union of all traits defined in Vcs.

This is a special class constructor that creates an object that satisfies the interface defined by the class type t, but where each of the actual method implementation is a function that returns an error indicating that the method is unimplemented.