package opam-repository

  1. Overview
  2. Docs

Configuration options for the repository lib (record, global reference, setter, initialisation)

module E : sig ... end
type dl_tool_kind = [
  1. | `Curl
  2. | `Default

Toggles parsing of the tool's output to detect errors (curl returns 0 on a 404)

type t = {
  1. download_tool : (OpamTypes.arg list * dl_tool_kind) Stdlib.Lazy.t;
  2. validation_hook : OpamTypes.arg list option;
  3. retries : int;
  4. force_checksums : bool option;
type 'a options_fun = ?download_tool:(OpamTypes.arg list * dl_tool_kind) Stdlib.Lazy.t -> ?validation_hook:OpamTypes.arg list option -> ?retries:int -> ?force_checksums:bool option -> 'a
include OpamStd.Config.Sig with type t := t and type 'a options_fun := 'a options_fun
val default : t

The default values of the options to use at startup

val set : t -> (unit -> t) options_fun

Use to update any option in a t, using the optional arguments of options_fun. E.g. set opts ?option1:1 ?option4:"x" ()

val setk : (t -> 'a) -> t -> 'a options_fun

Same as set, but passes the result to a continuation, allowing argument stacking

val r : t Stdlib.ref

The global reference containing the currently set library options. Access using OpamXxxConfig.(!r.field).

val update : ?noop:_ -> (unit -> unit) options_fun

Updates the currently set options in r according to the optional arguments

val init : ?noop:_ -> (unit -> unit) options_fun

Sets the options, reading the environment to get default values when unspecified

val initk : 'a -> 'a options_fun

Sets the options like init, but returns the given value (for arguments stacking)