package opam-solver

  1. Overview
  2. Docs

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

type t = private {
  1. cudf_file : string option;
  2. solver : (module OpamCudfSolver.S) Stdlib.Lazy.t;
  3. best_effort : bool;
  4. solver_preferences_default : string option Stdlib.Lazy.t;
  5. solver_preferences_upgrade : string option Stdlib.Lazy.t;
  6. solver_preferences_fixup : string option Stdlib.Lazy.t;
  7. solver_preferences_best_effort_prefix : string option Stdlib.Lazy.t;
  8. solver_timeout : float option;
  9. solver_allow_suboptimal : bool;
}
type 'a options_fun = ?cudf_file:string option -> ?solver:(module OpamCudfSolver.S) Stdlib.Lazy.t -> ?best_effort:bool -> ?solver_preferences_default:string option Stdlib.Lazy.t -> ?solver_preferences_upgrade:string option Stdlib.Lazy.t -> ?solver_preferences_fixup:string option Stdlib.Lazy.t -> ?solver_preferences_best_effort_prefix:string option Stdlib.Lazy.t -> ?solver_timeout:float option -> ?solver_allow_suboptimal:bool -> '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)

val call_solver : criteria:string -> Cudf.cudf -> Cudf.preamble option * Cudf.universe
val best_effort : unit -> bool

Checks if best_effort was set and is supported

val criteria : OpamTypes.solver_criteria -> string
OCaml

Innovation. Community. Security.