package file_path

  1. Overview
  2. Docs
package file_path
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module File_path_unixSource

Sourcemodule type S = sig ... end
include S
include File_path_io.S with type 'a io := 'a
Sourceval executable_name : File_path.t Core.Lazy.t

The currently running executable.

OCaml semantics do not guarantee an absolute path here.

File I/O Wrappers

These functions abstract over either In_channel and Out_channel, or Async.Reader and Async.Writer.

Sourceval read_file : File_path.t -> string
Sourceval write_file : File_path.t -> contents:string -> unit
Sourceval load_sexp : File_path.t -> Core.Sexp.t
Sourceval load_sexps : File_path.t -> Core.Sexp.t list
Sourceval load_as_sexp : File_path.t -> of_sexp:(Core.Sexp.t -> 'a) -> 'a
Sourceval load_as_sexps : File_path.t -> of_sexp:(Core.Sexp.t -> 'a) -> 'a list
Sourceval save_sexp : File_path.t -> Core.Sexp.t -> unit
Sourceval save_sexps : File_path.t -> Core.Sexp.t list -> unit
Sourceval save_as_sexp : File_path.t -> 'a -> sexp_of:('a -> Core.Sexp.t) -> unit
Sourceval save_as_sexps : File_path.t -> 'a list -> sexp_of:('a -> Core.Sexp.t) -> unit

Filename Wrappers

These functions abstract over Filename_unix.

Sourceval realpath_relative_to_cwd : File_path.t -> File_path.Absolute.t

Sys Wrappers

These functions abstract over either Core.Sys or Async.Sys.

Sourceval exists : File_path.t -> [ `Yes | `No | `Unknown ]
Sourceval exists_exn : File_path.t -> bool
Sourceval is_directory : File_path.t -> [ `Yes | `No | `Unknown ]
Sourceval is_directory_exn : File_path.t -> bool
Sourceval is_file : File_path.t -> [ `Yes | `No | `Unknown ]
Sourceval is_file_exn : File_path.t -> bool
Sourceval ls_dir : File_path.t -> File_path.Part.t list

Unix Wrappers

These functions abstract over either Core_unix or Async.Unix.

Sourceval rmdir : File_path.t -> unit
Sourceval chdir : File_path.t -> unit
Sourceval getcwd : unit -> File_path.Absolute.t
Sourceval rename : src:File_path.t -> dst:File_path.t -> unit
Sourceval mkdir : ?parents:bool -> File_path.t -> unit

Current Directory Functions

These functions combine File_path and getcwd.

Sourceval make_absolute_under_cwd : File_path.t -> File_path.Absolute.t

Like File_path.make_absolute ~under:(getcwd ()). Avoids calling getcwd unless necessary.

Sourceval make_relative_to_cwd : File_path.t -> File_path.Relative.t option

Like File_path.make_relative ~if_under:(getcwd ()). Avoids calling getcwd unless necessary.

Sourceval make_relative_to_cwd_exn : File_path.t -> File_path.Relative.t

Like make_relative_to_cwd. Raises instead of returning None.

Sourceval make_relative_to_cwd_if_possible : File_path.t -> File_path.t

Like make_relative_to_cwd. Returns the original path instead of None.