Module `OpamFile.Repo`Source

Repository metadata

include OpamFile.IO_FILE

Sourcetype t

File contents

Sourceval format_version : OpamVersion.t

Sourceval empty : OpamFile.Repo.t

Empty file

Sourceval write : OpamFile.Repo.t OpamFile.typed_file -> OpamFile.Repo.t -> unit

Write some contents to a file

Sourceval read : OpamFile.Repo.t OpamFile.typed_file -> OpamFile.Repo.t

Read file contents.

raises OpamSystem.Internal_error
if the file does not exist.

Sourceval read_opt : OpamFile.Repo.t OpamFile.typed_file -> OpamFile.Repo.t option

Returns None on non-existing file

Sourceval safe_read : OpamFile.Repo.t OpamFile.typed_file -> OpamFile.Repo.t

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

Source

val read_from_channel : 
  ?filename:OpamFile.Repo.t OpamFile.typed_file ->
  Stdlib.in_channel ->
  OpamFile.Repo.t

Source

val read_from_string : 
  ?filename:OpamFile.Repo.t OpamFile.typed_file ->
  string ->
  OpamFile.Repo.t

Source

val write_to_channel : 
  ?filename:OpamFile.Repo.t OpamFile.typed_file ->
  Stdlib.out_channel ->
  OpamFile.Repo.t ->
  unit

Source

val write_to_string : 
  ?filename:OpamFile.Repo.t OpamFile.typed_file ->
  OpamFile.Repo.t ->
  string

Source

val 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 ->
  OpamFile.Repo.t

Sourceval opam_version : OpamFile.Repo.t -> OpamVersion.t option

The minimum OPAM version required for this repository, if defined

Sourceval browse : OpamFile.Repo.t -> string option

Base URL for browsing packages on the WWW

Sourceval upstream : OpamFile.Repo.t -> string option

Base URL for browsing OPAM repository source on the WWW

Sourceval root_url : OpamFile.Repo.t -> OpamTypes.url option

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

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

Redirections.

Sourceval dl_cache : OpamFile.Repo.t -> string list

Cache URLs, either full or relative to the repo root

Sourceval announce : OpamFile.Repo.t -> (string * OpamTypes.filter option) list

Sourceval stamp : OpamFile.Repo.t -> string option

Sourceval with_opam_version : OpamVersion.t -> OpamFile.Repo.t -> OpamFile.Repo.t

Sourceval with_browse : string -> OpamFile.Repo.t -> OpamFile.Repo.t

Sourceval with_upstream : string -> OpamFile.Repo.t -> OpamFile.Repo.t

Source

val with_redirect : 
  (string * OpamTypes.filter option) list ->
  OpamFile.Repo.t ->
  OpamFile.Repo.t

Sourceval with_root_url : OpamTypes.url -> OpamFile.Repo.t -> OpamFile.Repo.t

Sourceval with_dl_cache : string list -> OpamFile.Repo.t -> OpamFile.Repo.t

Source

val with_announce : 
  (string * OpamTypes.filter option) list ->
  OpamFile.Repo.t ->
  OpamFile.Repo.t

Sourceval with_stamp : string -> OpamFile.Repo.t -> OpamFile.Repo.t

Sourceval with_stamp_opt : string option -> OpamFile.Repo.t -> OpamFile.Repo.t

Module OpamFile.RepoSource

Module `OpamFile.Repo`Source