package fpath-base

  1. Overview
  2. Docs
Adds a few functions to Fpath to use alongside Base

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (2)

Authors

  1. M
    Mathieu Barbin

Maintainers

  1. M
    Mathieu Barbin <opensource@mbarbin.org>

Sources

fpath-base-0.4.0.tbz
sha256=1d7c13dd6daf879876b80b72e403ba9334b921d51397ccb3f4e3ab64bebd93f7
sha512=51c9d2236f4707f22d5e09e9134482acf5c11e51b63ef9add4324a768e65ddfcf43fc7e6322fa2ee95e013cc00874ccb29926ad610bd38c5eacdd799dfba9623

doc/fpath-base/Fpath_base/Fsegment/index.html

Module Fpath_base.FsegmentSource

include module type of Fpath_sexp0.Fsegment with type t := t
Sourceval sexp_of_t : t -> Sexplib0.Sexp.t
Sourceval seeded_hash : int -> t -> int
Sourceval of_string : string -> (t, [ `Msg of string ]) Result.t
Sourceval to_string : t -> string
Sourceval v : string -> t
Sourceval dot : t

Unix "." file name.

Sourceval dot_dot : t

Unix ".." file name.

vcs

Version control store directories.

Sourceval dot_git : t
Sourceval dot_hg : t
include Base.Comparable.S with type t := t
include Base.Comparisons.S with type t := t
include Base.Comparisons.Infix with type t := t
Sourceval (>=) : t -> t -> bool
Sourceval (<=) : t -> t -> bool
Sourceval (=) : t -> t -> bool
Sourceval (>) : t -> t -> bool
Sourceval (<) : t -> t -> bool
Sourceval (<>) : t -> t -> bool
Sourceval equal : t -> t -> bool
Sourceval compare : t -> t -> int

compare t1 t2 returns 0 if t1 is equal to t2, a negative integer if t1 is less than t2, and a positive integer if t1 is greater than t2.

Sourceval min : t -> t -> t
Sourceval max : t -> t -> t
Sourceval ascending : t -> t -> int

ascending is identical to compare. descending x y = ascending y x. These are intended to be mnemonic when used like List.sort ~compare:ascending and List.sort ~cmp:descending, since they cause the list to be sorted in ascending or descending order, respectively.

Sourceval descending : t -> t -> int
Sourceval between : t -> low:t -> high:t -> bool

between t ~low ~high means low <= t <= high

Sourceval clamp_exn : t -> min:t -> max:t -> t

clamp_exn t ~min ~max returns t', the closest value to t such that between t' ~low:min ~high:max is true.

Raises if not (min <= max).

Sourceval clamp : t -> min:t -> max:t -> t Base.Or_error.t
include Base.Comparator.S with type t := t
Sourcetype comparator_witness
Sourceval hash : t -> Base.int
Sourceval hash_fold_t : Base.Hash.state -> t -> Base.Hash.state