package opam-format

  1. Overview
  2. Docs

Module OpamFile.Pinned_legacySource

Pinned package files (only used for migration from 1.2, the inclusive State module is now used instead)

Sourcetype pin_option =
  1. | Version of OpamTypes.version
  2. | Source of OpamTypes.url
include IO_FILE with type t = pin_option OpamTypes.name_map

File contents

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