package opam-format

  1. Overview
  2. Docs
Format library for opam 2.2

Install 

dune-project
 Dependency

opam.ocaml.org Readme Edit opam file Versions (33)

Authors

  1. David Allsopp
  2. V
    Vincent Bernardoff <vb@luminar.eu.org>
  3. R
    Raja Boujbel <raja.boujbel@ocamlpro.com>
  4. K
    Kate Deplaix <kit-ty-kate@outlook.com>
  5. R
    Roberto Di Cosmo <roberto@dicosmo.org>
  6. T
    Thomas Gazagnaire <thomas@gazagnaire.org>
  7. L
    Louis Gesbert <louis.gesbert@ocamlpro.com>
  8. F
    Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
  9. A
    Anil Madhavapeddy <anil@recoil.org>
  10. G
    Guillem Rieu <guillem.rieu@ocamlpro.com>
  11. R
    Ralf Treinen <ralf.treinen@pps.jussieu.fr>
  12. F
    Frederic Tuong <tuong@users.gforge.inria.fr>

Maintainers

  1. O
    opam-devel@lists.ocaml.org

Sources

2.2.1.tar.gz
md5=d9b85326877d02ffee49caee2384f170
sha512=17d7d83b9de118332c121b9d3aa2e48f62a6270ea23e730a536b0f4ff060df85238c7c4ab53a89bcc3b3193d52d14358831bd9bed30a4ac699e44e4c3003b8b0

doc/opam-format/OpamFile/Switch_config/index.html

Module OpamFile.Switch_configSource

Sourcetype t = {
  1. opam_version : OpamVersion.t;
  2. synopsis : string;
  3. repos : OpamTypes.repository_name list option;
  4. paths : (OpamTypes.std_path * string) list;
  5. variables : (OpamTypes.variable * OpamTypes.variable_contents) list;
  6. opam_root : OpamTypes.dirname option;
  7. wrappers : Wrappers.t;
  8. env : (OpamTypes.spf_resolved, OpamTypes.euok_writeable) OpamTypes.env_update list;
  9. invariant : OpamFormula.t option;
  10. depext_bypass : OpamSysPkg.Set.t;
}
Sourceval file_format_version : OpamVersion.t
Sourceval path : t -> OpamTypes.std_path -> string option
Sourceval wrappers : t -> Wrappers.t
Sourceval sections : (string * (t, (string option * OpamParserTypes.FullPos.opamfile_item list) list) OpamPp.field_parser) list
Sourceval to_list : ?filename:'a typed_file -> t -> (string * OpamParserTypes.FullPos.value) list
include IO_FILE with type t := t
Sourceval format_version : OpamVersion.t
Sourceval empty : t

Empty file

Sourceval write : t typed_file -> t -> unit

Write some contents to a file

Sourceval read : t typed_file -> t

Read file contents. Raise an error if the file does not exist.

Sourceval read_opt : t typed_file -> t option

Returns None on non-existing file

Sourceval safe_read : t typed_file -> t

Read file contents. Return empty if the file does not exist.

Sourceval read_from_channel : ?filename:t typed_file -> in_channel -> t
Sourceval read_from_string : ?filename:t typed_file -> string -> t
Sourceval write_to_channel : ?filename:t typed_file -> out_channel -> t -> unit
Sourceval write_to_string : ?filename:t typed_file -> t -> string
Sourceval oldest_compatible_format_version : OpamVersion.t
Sourcemodule BestEffort : BestEffortRead with type t := t