package stdune

  1. Overview
  2. Docs

Module Path.BuildSource

Sourcetype w
Sourceval hash : t -> int
Sourceval to_string : t -> string
Sourceval of_string : string -> t
Sourceval parse_string_exn : loc:Stdune__.Loc0.t -> string -> t

a directory is smaller than its descendants

include Comparator.S with type t := t
Sourceval compare : t -> t -> Ordering.t
include Comparator.OPS with type t := t
Sourceval equal : t -> t -> bool
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 to_dyn : t -> Dyn.t
Sourceval extension : t -> string
Sourceval set_extension : t -> ext:string -> t

set_extension path ~ext replaces extension of path by ext

Sourceval map_extension : t -> f:(string -> string) -> t

map_extension path ~f replaces extension of path by f extension

Sourceval split_extension : t -> t * string
Sourceval basename : t -> string
Sourceval basename_opt : t -> string option
Sourceval extend_basename : t -> suffix:string -> t
Sourcemodule Map : Map.S with type key = t
Sourcemodule Set : sig ... end
Sourcemodule Table : Hashtbl.S with type key = t
Sourceval to_string_maybe_quoted : t -> string
Sourceval is_descendant : t -> of_:t -> bool
Sourceval is_root : t -> bool
Sourceval parent_exn : t -> t
Sourceval parent : t -> t option
Sourceval root : t
Sourceval append_source : t -> Source.t -> t
Sourceval append_local : t -> Local.t -> t
Sourceval append : t -> t -> t

append x y is append_local x (local y)

Sourcemodule L : sig ... end
Sourceval relative : ?error_loc:Stdune__.Loc0.t -> t -> string -> t
Sourceval split_first_component : t -> (string * Local.t) option
Sourceval explode : t -> string list
Sourceval local : t -> Local.t
Sourceval drop_build_context : t -> Source.t option
Sourceval drop_build_context_exn : t -> Source.t
Sourceval drop_build_context_maybe_sandboxed_exn : t -> Source.t
Sourceval extract_build_context : t -> (string * Source.t) option

Source.t here is a lie in some cases: consider when the context name happens to be "install" or ".alias".

Sourceval extract_build_context_exn : t -> string * Source.t
Sourceval extract_build_context_dir : t -> (t * Source.t) option
Sourceval extract_build_context_dir_exn : t -> t * Source.t
Sourceval extract_first_component : t -> (string * Local.t) option

This function does the same as extract_build_context, but has a "righter" type.

Sourcemodule Kind : sig ... end
Sourceval set_build_dir : Kind.t -> unit

Set the build directory. Can only be called once and must be done before paths are converted to strings elsewhere.

Sourceval split_sandbox_root : t -> t option * t
Sourceval of_local : Local.t -> t
Sourceval chmod : t -> mode:int -> unit

Set permissions for a given path. You can use the Permissions module if you need to modify existing permissions in a non-trivial way.

Sourceval lstat : t -> Unix.stats