package opam-lib

You can search for identifiers within the package.

in-package search v0.2.0

opam-lib
- OpamCompat
- OpamConsole
- OpamCoreConfig
- OpamFilename
  - Attribute
    
    Map
    
    Set
    
    Op
  - Base
    
    Map
    
    Set
    
    Op
  - Dir
    
    Map
    
    Set
    
    Op
  - Map
  - Op
  - Set
    
    Op
- OpamJson
- OpamParallel
  - G
    
    E
    
    Topological
    
    V
    
    Vertex
  - GRAPH
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
    
    Topological
    
    V
  - Make
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
  - MakeGraph
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
    
    Topological
    
    V
  - SIG
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
  - VERTEX
- OpamProcess
  - Job
    
    Op
- OpamStd
  - ABSTRACT
    
    Map
    
    Set
    
    Op
  - AbstractString
    
    Map
    
    Set
    
    Op
  - Config
  - Env
  - Exn
  - Format
  - IntMap
  - IntSet
    
    Op
  - List
  - MAP
  - Map
    
    Make
    
    S
  - Op
  - Option
    
    Op
  - OrderedType
  - SET
    
    Op
  - Set
    
    Make
    
    Op
    
    S
  - String
    
    Map
    
    Set
    
    Op
    
    SetMap
    
    SetSet
    
    Op
  - Sys
- OpamSystem
- OpamVersion
  - Map
  - Set
    
    Op
- OpamVersionCompare
opam-lib.client
- OpamClient
  - API
    
    CONFIG
    
    PIN
    
    REPOSITORY
    
    SWITCH
  - SafeAPI
    
    CONFIG
    
    PIN
    
    REPOSITORY
    
    SWITCH
- OpamClientConfig
- OpamConfigCommand
- OpamPinCommand
- OpamRepositoryCommand
- OpamSwitchCommand
opam-lib.format
- OpamCompiler
  - Map
  - Set
    
    Op
  - Version
    
    Map
    
    Set
    
    Op
- OpamFile
  - Aliases
  - Comp
  - Compiler_index
  - Config
  - Descr
  - Dot_config
  - Dot_install
  - Export
  - File_attributes
  - Filenames
  - IO_FILE
  - Installed
  - Installed_roots
  - Lines
  - OPAM
  - Package_index
  - Pinned
  - Prefix
  - Reinstall
  - Repo
  - Repo_config
  - URL
- OpamFilter
- OpamFormat
- OpamFormatConfig
- OpamFormula
- OpamLexer
- OpamLineLexer
- OpamPackage
  - Graph
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
    
    Topological
    
    V
  - Map
  - Name
    
    Map
    
    Set
    
    Op
  - Set
    
    Op
  - Version
    
    Map
    
    Set
    
    Op
- OpamParser
- OpamRepositoryName
  - Map
  - Set
    
    Op
- OpamSwitch
  - Map
  - Set
    
    Op
- OpamTypesBase
- OpamVariable
  - Full
    
    Map
    
    Set
    
    Op
  - Map
  - Set
    
    Op
opam-lib.repository
- OpamDarcs
  - B
- OpamDownload
- OpamGit
  - B
- OpamHTTP
  - B
- OpamHg
  - B
- OpamLocal
  - B
- OpamRepository
- OpamRepositoryBackend
  - S
- OpamRepositoryConfig
- OpamRepositoryPath
- OpamVCS
  - Make
    
    VCS
  - VCS
opam-lib.solver
- OpamActionGraph
  - ACTION
    
    Pkg
  - Make
    
    A
    
    Pkg
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
    
    Topological
    
    V
  - MakeAction
    
    P
    
    Pkg
  - SIG
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
    
    Topological
    
    V
- OpamCudf
  - ActionGraph
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
    
    Topological
    
    V
  - Graph
  - Map
  - Set
    
    Op
- OpamHeuristic
- OpamSolver
  - Action
    
    Pkg
  - ActionGraph
    
    Dot
    
    E
    
    Parallel
    
    G
    
    E
    
    Topological
    
    V
    
    Vertex
    
    Topological
    
    V
- OpamSolverConfig
opam-lib.state
- OpamAction
- OpamOCaml
- OpamPath
  - Switch
    
    Default
    
    Overlay
- OpamScript
- OpamSolution
- OpamState
  - Cache
  - Types
- OpamStateConfig

Legend:
Library
Module
Module type
Parameter
Class
Class type

OPAM actions

val download_package : 
  OpamState.Types.t ->
  OpamTypes.package ->
  [ `Error of string | `Successful of OpamTypes.generic_file option ]
    OpamProcess.job

Downloads the source for a package to the local cache. Returns the file or dir downloaded, or None if the download failed.

val extract_package : 
  OpamState.Types.t ->
  OpamTypes.generic_file option ->
  OpamTypes.package ->
  unit

Extracts and patches the source of a package

val build_package : 
  OpamState.Types.t ->
  OpamTypes.generic_file option ->
  OpamTypes.package ->
  exn option OpamProcess.job

Build a package from its downloaded source. Returns None on success, Some exn on error.

val install_package : 
  OpamState.Types.t ->
  OpamTypes.package ->
  exn option OpamProcess.job

Installs a compiled package from its build dir. Returns None on success, Some exn on error.

val removal_needs_download : OpamState.Types.t -> OpamTypes.package -> bool

Find out if the package source is needed for uninstall

val remove_package : 
  OpamState.Types.t ->
  metadata:bool ->
  ?keep_build:bool ->
  ?silent:bool ->
  OpamTypes.package ->
  unit OpamProcess.job

Remove a package.

val cleanup_package_artefacts : OpamState.Types.t -> OpamTypes.package -> unit

Removes auxiliary files related to a package, after checking that they're not needed (even in other switches)

val sources_needed : 
  OpamState.Types.t ->
  OpamSolver.ActionGraph.t ->
  OpamTypes.package_set

Compute the set of packages which will need to be downloaded to apply a solution. Takes a graph of atomic actions.

val update_metadata : 
  OpamState.Types.t ->
  installed:OpamTypes.package_set ->
  installed_roots:OpamTypes.package_set ->
  reinstall:OpamTypes.package_set ->
  OpamState.Types.t

Update package metadata