package topkg

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Existence and contents
Current working directory

package topkg

topkg
- Topkg
  - Cmd
  - Conf
    
    OCaml
  - Exts
  - Fpath
  - Log
  - OS
    
    Cmd
    
    Dir
    
    Env
    
    File
  - Pkg
  - Private
    
    Codec
    
    Ipc
    
    Opam
    
    File
    
    Pkg
  - R
  - String
  - Vcs

Legend:
Library
Module
Module type
Parameter
Class
Class type

Directory operations.

Existence and contents

val exists : fpath -> bool result

exists dir is true if directory dir exists in the file system. Symbolic links are followed.

val must_exist : fpath -> fpath result

must_exist dir is dir if file is a regular file in the file system and an error otherwise. Symbolic links are followed.

val contents : ?dotfiles:bool -> ?rel:bool -> fpath -> fpath list result

contents ~dotfiles ~rel dir is the list of directories and filse in dir. If rel is true (defaults to false) the resulting paths are relative to dir, otherwise they have dir prepended. If dotfiles is false (default) elements that start with a . are omitted.

Current working directory

val current : unit -> fpath result

current () is the current working directory.

val set_current : fpath -> unit result

set_current dir sets the current working directory to dir.

val with_current : fpath -> ('a -> 'b) -> 'a -> 'b result

with_current dir f v is f v with the current working directory bound to dir. After the function returns the current working directory is back to its initial value.