package opam-core

You can search for identifiers within the package.

in-package search v0.2.0

package opam-core

opam-core
- Library opam-core
  - OpamACL
  - OpamCached
    
    ARG
    
    Make
  - OpamCompat
    
    String
    
    Seq
    
    Either
    
    Lazy
    
    Unix
    
    Filename
  - OpamConsole
    
    Symbols
    
    Tree
  - OpamCoreConfig
    
    E
  - OpamCoreConfigDeveloper
  - OpamDirTrack
  - OpamFilename
    
    Base
    
    Set
    
    Op
    
    Map
    
    Dir
    
    Set
    
    Op
    
    Map
    
    Set
    
    Op
    
    Map
    
    Op
    
    Attribute
    
    Set
    
    Op
    
    Map
    
    SubPath
    
    Set
    
    Op
    
    Map
  - OpamHash
    
    Set
    
    Op
    
    Map
  - OpamJson
  - OpamParallel
    
    VERTEX
    
    G
    
    V
    
    E
    
    Vertex
    
    Topological
    
    SIG
    
    G
    
    V
    
    E
    
    Vertex
    
    Topological
    
    Make
    
    G
    
    V
    
    E
    
    Vertex
    
    Topological
    
    GRAPH
    
    V
    
    E
    
    Topological
    
    Parallel
    
    G
    
    V
    
    E
    
    Vertex
    
    Topological
    
    Dot
    
    MakeGraph
    
    V
    
    E
    
    Topological
    
    Parallel
    
    G
    
    V
    
    E
    
    Vertex
    
    Topological
    
    Dot
  - OpamProcess
    
    Job
    
    Op
  - OpamSHA
  - OpamSWHID
    
    Set
    
    Op
    
    Map
  - OpamStd
    
    SET
    
    Op
    
    MAP
    
    ABSTRACT
    
    Set
    
    Op
    
    Map
    
    AbstractString
    
    Set
    
    Op
    
    Map
    
    OrderedType
    
    Set
    
    Make
    
    Op
    
    Map
    
    Make
    
    IntMap
    
    IntSet
    
    Op
    
    Option
    
    Op
    
    List
    
    String
    
    Map
    
    Set
    
    Op
    
    SetSet
    
    Op
    
    SetMap
    
    Format
    
    Exn
    
    Env
    
    Name
    
    Set
    
    Op
    
    Map
    
    Sys
    
    Win32
    
    RegistryHive
    
    Op
    
    Config
    
    Sig
    
    E
    
    Compare
  - OpamStubs
  - OpamStubsTypes
  - OpamSystem
  - OpamUrl
    
    Set
    
    Op
    
    Map
    
    Op
  - OpamVersion
    
    Set
    
    Op
    
    Map
  - OpamVersionCompare
  - OpamVersionInfo
- Sources
  - opam-core
    
    opamACL.ml
    
    opamCached.ml
    
    opamCompat.ml
    
    opamConsole.ml
    
    opamCoreConfig.ml
    
    opamCoreConfigDeveloper.ml
    
    opamDirTrack.ml
    
    opamFilename.ml
    
    opamHash.ml
    
    opamJson.ml
    
    opamParallel.ml
    
    opamProcess.ml
    
    opamSHA.ml
    
    opamSWHID.ml
    
    opamStd.ml
    
    opamStubs.ml
    
    opamStubsTypes.ml
    
    opamSystem.ml
    
    opamUrl.ml
    
    opamVersion.ml
    
    opamVersionCompare.ml
    
    opamVersionInfo.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `OpamUrl`Source

URL parsing and printing, with support for our different backends

Sourcetype version_control = [

| `git
| `darcs
| `hg

]

Sourcetype backend = [

| `http
| `rsync
| version_control

]

Sourceval string_of_backend : backend -> string

Sourceexception Parse_error of string

Sourceval backend_of_string : string -> [> backend ]

Tolerates lots of backward compatibility names;

raises Parse_error
on unknown protocol

Sourcetype t = {

transport : string;
(*
the part just before '://'
*)
path : string;
(*
the part after '://'
*)
hash : string option;
(*
the optional branch/ref specification, at the end after a '#'
*)
backend : backend;
(*
the backend that opam should use to handle this url
*)

}

Source

val parse : 
  ?backend:backend ->
  ?handle_suffix:bool ->
  ?from_file:bool ->
  string ->
  t

Same as of_string, but allows enforcing the expected backend, and may otherwise guess version control from the suffix by default (for e.g. https://foo/bar.git). (this should be disabled when parsing from files). Note that handle_suffix also handles user-name in ssh addresses (e.g. "ssh://git@github.com/..."). If from_file is set to false, it resolves rsync/file relative path.

raises Parse_error

Source

val parse_opt : 
  ?quiet:bool ->
  ?backend:backend ->
  ?handle_suffix:bool ->
  ?from_file:bool ->
  string ->
  t option

Same as parse, but catch Parse_error. In this case, display a warning if quiet is not set to true.

include OpamStd.ABSTRACT with type t := t

Sourceval compare : t -> t -> int

Sourceval equal : t -> t -> bool

Sourceval of_string : string -> t

Sourceval to_string : t -> string

Sourceval to_json : t OpamJson.encoder

Sourceval of_json : t OpamJson.decoder

Sourcemodule Set : OpamStd.SET with type elt = t

Sourcemodule Map : OpamStd.MAP with type key = t

Sourceval to_string_w_subpath : OpamFilename.SubPath.t option -> t -> string

Sourceval empty : t

Dummy filler url

Sourceval base_url : t -> string

Returns the url string without the VC part (i.e. "git+foo://bar" returns "foo://bar")

Sourceval basename : t -> string

The last part of the url path, e.g. "http://foo/bar/this" or "http://that.here/"

Sourceval root : t -> t

Returns the url with all path components but the first one (the hostname) dropped, e.g. "http://some.host/some/path" becomes "http://some.host"

Sourceval has_trailing_slash : t -> bool

Sourceval local_dir : t -> OpamFilename.Dir.t option

Check if the URL matches an existing local directory, and return it

Sourceval local_file : t -> OpamFilename.t option

Check if the URL matches an existing local file, and return it

Sourceval guess_version_control : string -> [> version_control ] option

If the given url-string has no 'transport://' specification and corresponds to an existing local path, check for version-control clues at that path

Sourceval map_file_url : (string -> string) -> t -> t

map_file_url f url applies f to the path portion of url if transport is "file".

Sourcemodule Op : sig ... end

package opam-core

Module OpamUrlSource

Module `OpamUrl`Source