package opam-lib

  1. Overview
  2. Docs
package opam-lib
Legend:
Library
Module
Module type
Parameter
Class
Class type

.config files

include IO_FILE
type t

File contents

val empty : t

Empty file

val write : OpamTypes.filename -> t -> unit

Write some contents to a file

val read : OpamTypes.filename -> t

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

val safe_read : OpamTypes.filename -> t

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

val read_from_channel : ?filename:OpamTypes.filename -> in_channel -> t

Read from channel.

val read_from_string : ?filename:OpamTypes.filename -> string -> t
val write_to_channel : out_channel -> t -> unit

Write to channel.

Create a new .config file (containing only variables)

Top-level variables

val variables : t -> OpamTypes.variable list

The list of top-level variables

Lists all the bindings in the file

Sets the given variable, overriding any previous definition. With None, unsets the variable