Fs Api Documentation

Current working directory. This cannot be changed in the JVM. Changing this will only change the working directory for functions in this library.

Return absolute file.

Return true if path is absolute.

Return the base name (final segment/file part) of a path.

If optional trim-ext is a string and the path ends with that string, it is trimmed.

If trim-ext is true, any extension is trimmed.

set!s the value of *cwd* to path. Only works inside of with-mutable-cwd

Takes two paths and checks to see if the first path is a parent of the second.

Change file permissions. Returns path.

mode can be a permissions string in octal or symbolic format. Symbolic: any combination of r (readable) w (writable) and x (executable). It should be prefixed with + to set or - to unset. And optional prefix of u causes the permissions to be set for the owner only. Octal: a string of three octal digits representing user, group, and world permissions. The three bits of each digit signify read, write, and execute permissions (in order of significance). Note that group and world permissions must be equal.

Examples:

(chmod "+x" "/tmp/foo") ; Sets executable for everyone
(chmod "u-wx" "/tmp/foo") ; Unsets owner write and executable

Copy a file from from to to. Return to.

Copy src to dest, create directories if needed.

Copy a directory from from to to. If to already exists, copy the directory to a directory with the same name as from within the to directory.

Copy directory into another directory if destination already exists.

Create a new file.

Delete path.

Delete a directory tree. Optional link-options may be provided to determine whether or not to follow symbolic links.

Return true if path is a directory, false otherwise. Optional link-options may be provided to determine whether or not to follow symbolic links.

Create an ephemeral directory (will be deleted on JVM exit). Returns nil if dir could not be created even after n tries (default 10).

Create an ephemeral file (will be deleted on JVM exit). Returns nil if file could not be created even after n tries (default 10).

Execute a shell command in the current directory

Return true if path is executable.

Return true if path exists.

If path begins with a tilde (~), expand the tilde to the value of the user.home system property. If the path begins with a tilde immediately followed by some characters, they are assumed to be a username. This is expanded to the path to that user’s home directory. This is (naively) assumed to be a directory with the same name as the user relative to the parent of the current value of user.home.

Return the extension part of a file.

If path is a period, replaces it with cwd and creates a new File object out of it and paths. Or, if the resulting File object does not constitute an absolute path, makes it absolutely by creating a new File object out of the paths and cwd.

Return true if path is a file.

Find files matching given pattern.

Find files in path by pred.

Returns files matching glob pattern.

Return true if path is hidden.

With no arguments, returns the current value of the user.home system property. If a user is passed, returns that user’s home directory. It is naively assumed to be a directory with the same name as the user located relative to the parent of the current value of user.home.

Return a sequence [root dirs files], starting from path in depth-first order

Create a “hard” link from path to target. Requires Java version 7 or greater. The arguments are in the opposite order from the link(2) system call.

Return true if path is a link. Requires Java version 7 or greater.

List files and directories under path.

Create a directory.

Make directory tree.

Return file modification time.

Move or rename a file to a target file. Requires Java version 7 or greater. Optional copy-options may be provided.

Return the name part of a file.

Return normalized (canonical) file.

Takes a namespace symbol and creates a path to it. Replaces hyphens with underscores. Assumes the path should be relative to cwd.

Return the parent path.

Get all the parent directories of a path.

Takes a path to a Clojure file and constructs a namespace symbol out of the path.

Return the target of a ‘soft’ link. Requires Java version 7 or greater.

Return true if path is readable.

Rename old-path to new-path. Only works on files.

Return size (in bytes) of file.

Split path to components.

Returns a vector of [name extension].

Create a “soft” link from path to target. Requires Java version 7 or greater.

Create a temporary directory. Returns nil if dir could not be created even after n tries (default 10).

Create a temporary file. Returns nil if file could not be created even after n tries (default 10).

Create a temporary file name like what is created for temp-file and temp-dir.

The temporary file directory looked up via the java.io.tmpdir system property. Does not create a temporary directory.

Set file modification time (default to now). Returns path.

The root of a unix system is /, nil on Windows

Lazily walk depth-first over the directory structure starting at path calling func with three arguments [root dirs files]. Returns a sequence of the results.

Execute body with a changed working directory.

Execute the body in a binding with *cwd* bound to *cwd*. This allows you to change *cwd* with set!.

Return true if path is writeable.