package opam-core

  1. Overview
  2. Docs
Core library for opam 2.6

Install 

dune-project
 Dependency

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

Authors

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

Maintainers

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

Sources

2.6.0.tar.gz
md5=33de6843fe6e44bf715623fe5fa42d32
sha512=512fc80cf12d277c226bbeed14ce4aeef7ec4aeaa970e76dddf9fb763b310b0209284fd6c83773b3fa63e42c7f09ddf6e3c6b84a0db2de6cc9e58a933124f2b3

doc/opam-core/OpamUrl/index.html

Module OpamUrlSource

URL parsing and printing, with support for our different backends

Sourcetype version_control = [
  1. | `git
  2. | `darcs
  3. | `hg
]
Sourcetype backend = [
  1. | `http
  2. | `rsync
  3. | 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;

Sourcetype 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

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

Sourceval 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
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 looks_like_local_path : t -> string option

Check if the URL looks like a local path and returns Some url.path if it does. Return None otherwise.

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