package opam-format

  1. Overview
  2. Docs

Module OpamFile.SwitchExportSource

An extended version of SwitchSelections that can include full opam files as package "name" {} sections, for storing overlays

Sourcetype t = {
  1. selections : OpamTypes.switch_selections;
  2. extra_files : string OpamHash.Map.t;
  3. overlays : OPAM.t OpamPackage.Name.Map.t;
}
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.

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