package conex

  1. Overview
  2. Docs

Module Conex_ioSource

IO operations

Conex relies on providers to read data from and write data to. Each access consists of a path used as key. Only basic file types are supported (no symbolic links).

IO provider

Sourcetype t = {
  1. basedir : string;
  2. description : string;
  3. file_type : Conex_utils.path -> (Conex_utils.file_type, string) result;
  4. read : Conex_utils.path -> (string, string) result;
  5. write : Conex_utils.path -> string -> (unit, string) result;
  6. read_dir : Conex_utils.path -> (Conex_utils.item list, string) result;
  7. exists : Conex_utils.path -> bool;
}

A provider contains its base directory, a description, and read/write/exist functionality. TODO: define this as a module type.

pp t is a pretty printer for t.

Listings

Sourceval ids : t -> (Conex_utils.S.t, string) result

ids t are all ids present on t.

Sourceval packages : t -> (Conex_utils.S.t, string) result

packages t are all packages present on t.

Sourceval releases : t -> Conex_resource.name -> (Conex_utils.S.t, string) result

releases t name are all releases of name on t.

Resource computation

Sourcetype cc_err = [
  1. | `FileNotFound of Conex_resource.name
  2. | `NotADirectory of Conex_resource.name
]

The variant of errors when computing checksums

pp_cc_err is a pretty printer for cc_err.

compute_release digestf t now name computes the release by computing checksums of all files and directories of name using digestf. If release name is not found, an error is signalled.

compute_package t create name computes the package by listing all subdirectories of name.

Reading of resource files

The variant of read and parse errors.

pp_r_err is a pretty printer for r_err.

Sourceval read_id : t -> Conex_resource.identifier -> ([ `Author of Conex_resource.Author.t | `Team of Conex_resource.Team.t ], [> r_err ]) result

read_id t id reads and parses the given identifier on t.

read_author t id reads and parses the given author on t.

read_team t id reads and parses the given team on t.

read_authorisation t name reads and parses the authorisation for the given name on t.

read_package t name reads and parses the package for the given name on t.

read_release t name.version reads and parses the release for the given name.version on t.

Writing of resources to files

Sourceval write_author : t -> Conex_resource.Author.t -> (unit, string) result

write_author t author writes the given author on t.

Sourceval write_team : t -> Conex_resource.Team.t -> (unit, string) result

write_team t team writes the given team on t.

Sourceval write_authorisation : t -> Conex_resource.Authorisation.t -> (unit, string) result

write_authorisation t a writes the given authorisation on t.

Sourceval write_package : t -> Conex_resource.Package.t -> (unit, string) result

write_package t p writes the given package on t.

Sourceval write_release : t -> Conex_resource.Release.t -> (unit, string) result

write_release t r writes the given release on t.