package ocamlformat-lib

  1. Overview
  2. Docs
package ocamlformat-lib
Legend:
Library
Module
Module type
Parameter
Class
Class type
include module type of Fpath
val dir_sep : string
val is_seg : string -> bool
val is_rel_seg : string -> bool
type t
val v : string -> t
val add_seg : t -> string -> t
val (/) : t -> string -> t
val append : t -> t -> t
val (//) : t -> t -> t
val split_volume : t -> string * t
val segs : t -> string list
val is_dir_path : t -> bool
val is_file_path : t -> bool
val to_dir_path : t -> t
val filename : t -> string
val split_base : t -> t * t
val base : t -> t
val basename : t -> string
val parent : t -> t
val rem_empty_seg : t -> t
val normalize : t -> t
val is_prefix : t -> t -> bool
val find_prefix : t -> t -> t option
val rem_prefix : t -> t -> t option
val relativize : root:t -> t -> t option
val is_rooted : root:t -> t -> bool
val is_rel : t -> bool
val is_abs : t -> bool
val is_root : t -> bool
val is_current_dir : ?prefix:bool -> t -> bool
val is_parent_dir : ?prefix:bool -> t -> bool
val is_dotfile : t -> bool
val equal : t -> t -> bool
val compare : t -> t -> int
val of_string : string -> (t, [ `Msg of string ]) Stdlib.result
val dump : Stdlib.Format.formatter -> t -> unit
type ext = string
val get_ext : ?multi:bool -> t -> ext
val has_ext : ext -> t -> bool
val mem_ext : ext list -> t -> bool
val exists_ext : ?multi:bool -> t -> bool
val add_ext : ext -> t -> t
val rem_ext : ?multi:bool -> t -> t
val set_ext : ?multi:bool -> ext -> t -> t
val split_ext : ?multi:bool -> t -> t * ext
val (+) : t -> ext -> t
val (-+) : t -> ext -> t
type path = t
type set
module Set : sig ... end
module Map : sig ... end
type !'a map = 'a Map.t
val cwd : unit -> t

Current working directory.

val exists : t -> bool

exists p returns whether the given path p exists.

val to_absolute : t -> t

to_absolute p returns cwd/p if the p is relative, otherwise returns p.

val to_string : ?relativize:bool -> t -> string

If relativize is set to true (it is set to false by default), the path is relativized according to the cwd.

val pp : Stdlib.Format.formatter -> t -> unit
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct