package opam-format

  1. Overview
  2. Docs
Format library for opam 2.5

Install 

dune-project
 Dependency

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

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.5.2.tar.gz
md5=708dfb9799ebb5b9fccbdac63d0bf1e8
sha512=0b15627c4a31d3abcdbb5885bf2e7f4dee9ffddad2144855d1e1e18d66edc379e3a2b0a378097c35897e571f856b61aadabb47672d75401f6f6231f33ae475c8

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

Module OpamFile.RepoSource

Repository metadata

include IO_FILE
Sourcetype t

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
Sourceval create : ?browse:string -> ?upstream:string -> ?opam_version:OpamVersion.t -> ?redirect:(string * OpamTypes.filter option) list -> ?root_url:OpamTypes.url -> ?dl_cache:string list -> ?announce:(string * OpamTypes.filter option) list -> ?stamp:string -> unit -> t
Sourceval opam_version : t -> OpamVersion.t option

The minimum OPAM version required for this repository, if defined

Sourceval browse : t -> string option

Base URL for browsing packages on the WWW

Sourceval upstream : t -> string option

Base URL for browsing OPAM repository source on the WWW

Sourceval root_url : t -> OpamTypes.url option

The root URL of the repository (not an actual file field, determined at runtime by opam)

Sourceval redirect : t -> (string * OpamTypes.filter option) list

Redirections.

Sourceval dl_cache : t -> string list

Cache URLs, either full or relative to the repo root

Sourceval announce : t -> (string * OpamTypes.filter option) list
Sourceval stamp : t -> string option
Sourceval with_opam_version : OpamVersion.t -> t -> t
Sourceval with_browse : string -> t -> t
Sourceval with_upstream : string -> t -> t
Sourceval with_redirect : (string * OpamTypes.filter option) list -> t -> t
Sourceval with_root_url : OpamTypes.url -> t -> t
Sourceval with_dl_cache : string list -> t -> t
Sourceval with_announce : (string * OpamTypes.filter option) list -> t -> t
Sourceval with_stamp : string -> t -> t
Sourceval with_stamp_opt : string option -> t -> t