package opam-core

  1. Overview
  2. Docs
Core library for opam 2.1

Install 

dune-project
 Dependency

opam.ocaml.org Readme Edit opam file Versions (30)

Authors

  1. V
    Vincent Bernardoff <vb@luminar.eu.org>
  2. R
    Raja Boujbel <raja.boujbel@ocamlpro.com>
  3. R
    Roberto Di Cosmo <roberto@dicosmo.org>
  4. T
    Thomas Gazagnaire <thomas@gazagnaire.org>
  5. L
    Louis Gesbert <louis.gesbert@ocamlpro.com>
  6. F
    Fabrice Le Fessant <Fabrice.Le_fessant@inria.fr>
  7. A
    Anil Madhavapeddy <anil@recoil.org>
  8. G
    Guillem Rieu <guillem.rieu@ocamlpro.com>
  9. R
    Ralf Treinen <ralf.treinen@pps.jussieu.fr>
  10. F
    Frederic Tuong <tuong@users.gforge.inria.fr>

Maintainers

  1. O
    opam-devel@lists.ocaml.org

Sources

2.1.0-beta4.tar.gz
md5=c8b674ab0803330a1daaa241b067c7e3
sha512=d9ee987a173a013a40a2ab1765f7e2d71bdc1b191e868ec99f4b60e9b6792b1850894a484b9770ae7fb4a540a9fd3f2417506701924f45430a2a31125ba5784f

doc/opam-core/OpamUrl/index.html

Module OpamUrl

URL parsing and printing, with support for our different backends

type version_control = [
  1. | `git
  2. | `darcs
  3. | `hg
]
type backend = [
  1. | `http
  2. | `rsync
  3. | version_control
]
val string_of_backend : backend -> string
exception Parse_error of string
val backend_of_string : string -> [> backend ]

Tolerates lots of backward compatibility names;

type t = {
  1. transport : string;
    (*

    the part just before '://'

    *)
  2. path : string;
    (*

    the part after '://'

    *)
  3. hash : string option;
    (*

    the optional branch/ref specification, at the end after a '#'

    *)
  4. backend : backend;
    (*

    the backend that opam should use to handle this url

    *)
}
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.

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
val of_string : string -> t
val to_string : t -> string
val to_json : t -> OpamJson.t
val of_json : OpamJson.t -> t option
module Set : OpamStd.SET with type elt = t
module Map : OpamStd.MAP with type key = t
val empty : t

Dummy filler url

val base_url : t -> string

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

val basename : t -> string

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

val 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"

val has_trailing_slash : t -> bool
val local_dir : t -> OpamFilename.Dir.t option

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

val local_file : t -> OpamFilename.t option

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

val 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

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

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

module Op : sig ... end