Module `OpamRepositoryState`Source

loading and handling of the repository state of an opam root (i.e. what is in ~/.opam/repo)

Sourcemodule Cache : sig ... end

Caching of repository loading (marshall of all parsed opam files)

val load : 
  'a OpamStateTypes.lock ->
  [< OpamStateTypes.unlocked ] OpamStateTypes.global_state ->
  'a OpamStateTypes.repos_state

Source

val with_ : 
  'a OpamStateTypes.lock ->
  [< OpamStateTypes.unlocked ] OpamStateTypes.global_state ->
  ('a OpamStateTypes.repos_state -> 'b) ->
  'b

Loads the repository state as load, and calls the given function while keeping it locked (as per the lock argument), releasing the lock afterwards

Source

val find_package_opt : 
  'a OpamStateTypes.repos_state ->
  OpamTypes.repository_name list ->
  OpamTypes.package ->
  (OpamTypes.repository_name * OpamFile.OPAM.t) option

Returns the repo of origin and metadata corresponding to a package, if found, from a sorted list of repositories (highest priority first)

Source

val build_index : 
  'a OpamStateTypes.repos_state ->
  OpamTypes.repository_name list ->
  OpamFile.OPAM.t OpamPackage.Map.t

Given the repos state, and a list of repos to use (highest priority first), build a map of all existing package definitions

Source

val get_repo : 
  'a OpamStateTypes.repos_state ->
  OpamTypes.repository_name ->
  OpamTypes.repository

Finds a package repository definition from its name (assuming it's in ROOT/repos/)

Sourceval load_repo_opams : OpamTypes.repository -> OpamFile.OPAM.t OpamPackage.Map.t

Load all the metadata within the local mirror of the given repository, without cache

Source

val unlock : 
  'a OpamStateTypes.repos_state ->
  OpamStateTypes.unlocked OpamStateTypes.repos_state

Releases any locks on the given repos_state

Source

val with_write_lock : 
  ?dontblock:bool ->
  'a OpamStateTypes.repos_state ->
  (OpamStateTypes.rw OpamStateTypes.repos_state ->
    'b * OpamStateTypes.rw OpamStateTypes.repos_state) ->
  'b * 'a OpamStateTypes.repos_state

Calls the provided function, ensuring a temporary write lock on the given repository state

Sourceval write_config : OpamStateTypes.rw OpamStateTypes.repos_state -> unit

Writes the repositories config file back to disk

Install

Dune Dependency

Authors

Maintainers

Sources

doc/opam-state/OpamRepositoryState/index.html

Module `OpamRepositoryState`Source

package opam-state

Install

Dune Dependency

Authors

Maintainers

Sources

doc/opam-state/OpamRepositoryState/index.html

Module OpamRepositoryStateSource

Module `OpamRepositoryState`Source