opam-state 2.2.1 · OCaml Package

Specific query and handling of pinned packages

val version : 
  'a OpamStateTypes.switch_state ->
  OpamTypes.name ->
  OpamTypes.version

Returns the version the package is pinned to.

raises Not_found
when appropriate

val version_opt : 
  'a OpamStateTypes.switch_state ->
  OpamTypes.name ->
  OpamTypes.version option

If the package is pinned, returns its version. Otherwise returns None.

val package : 
  'a OpamStateTypes.switch_state ->
  OpamTypes.name ->
  OpamTypes.package

Returns the package with the pinned-to version from a pinned package name.

raises Not_found
when appropriate

val package_opt : 
  'a OpamStateTypes.switch_state ->
  OpamTypes.name ->
  OpamTypes.package option

Returns the package with the pinned-to version from a package name, if pinned

val packages : 'a OpamStateTypes.switch_state -> OpamTypes.package_set

The set of all pinned packages with their pinning versions

val find_opam_file_in_source : 
  ?locked:string ->
  OpamTypes.name ->
  OpamTypes.dirname ->
  (OpamFile.OPAM.t OpamFile.t * string option) option

Looks up an 'opam' file for the given named package in a source directory.

val files_in_source : 
  ?locked:string ->
  ?recurse:bool ->
  ?subpath:OpamTypes.subpath ->
  OpamTypes.dirname ->
  OpamStateTypes.nameopt_and_file list

Finds all package definition files in a given source dir opam, pkgname.opam/opam, etc. This is affected by OpamStateConfig.(!r.locked)

val files_in_source_w_target : 
  ?locked:string ->
  ?recurse:bool ->
  ?subpath:OpamTypes.subpath ->
  ?same_kind:(OpamTypes.url -> bool) ->
  OpamTypes.url ->
  OpamTypes.dirname ->
  OpamStateTypes.nameopt_and_file_w_url list

val name_of_opam_filename : 
  ?locked:string ->
  OpamTypes.dirname ->
  OpamTypes.filename ->
  OpamTypes.name option

From an opam file location, sitting below the given project directory, find the corresponding package name if specified (<name>.opam or <name>.opam/opam). This function doesn't check the project directory name itself, or the package name that might be specified within the file.

val orig_opam_file : 
  'a OpamStateTypes.switch_state ->
  OpamPackage.Name.t ->
  OpamFile.OPAM.t ->
  OpamFile.OPAM.t OpamFile.t option

Finds back the location of the opam file this package definition was loaded from

package opam-state