Liking cljdoc? Tell your friends :D

makejack.api.filesystem

File system manipulation functions.

File system manipulation functions.
raw docstring

chmodclj

(chmod path-like mode)

Change file mode, given octal mode specification as string.

Change file mode, given octal mode specification as string.
raw docstring

copy-file!clj

(copy-file! source-path target-path)

copy-optionsclj


cwdclj

(cwd)

Rturn the current working directory as a Path.

Rturn the current working directory as a Path.
raw docstring

delete-file!clj

(delete-file! path-like)

Delete the file at the specified path-like. Semantics as for java.nio.file.Files/delete.

Delete the file at the specified path-like.
Semantics as for java.nio.file.Files/delete.
raw docstring

delete-on-exit-if-exists!clj

(delete-on-exit-if-exists! path-like)

delete-recursively!clj

(delete-recursively! path-like)

empty-file-attributesclj


file-exists?clj

(file-exists? path-like)

Predicate for the given path existing.

Predicate for the given path existing.
raw docstring

file?clj

(file? path-like)

Predicate for path referring to a file.

Predicate for path referring to a file.
raw docstring

list-pathsclj

(list-paths path-like)

Return a lazy sequence of paths under path in depth first order.

Return a lazy sequence of paths under path in depth first order.
raw docstring

make-temp-dirclj

(make-temp-dir prefix-or-options)

Return a newly created temporary directory. Prefix is an arbitary string that is used to name the directory. Options is a map with the keys: :delete-on-exit - delete the dir on JVM exit (default true). :dir - directory to create the dir in (default is the system temp dir). Must be of type that can be passed to clojure.java.io/dir. :prefix - a string that is used to name the directory.

Return a newly created temporary directory.
Prefix is an arbitary string that is used to name the directory.
Options is a map with the keys:
:delete-on-exit - delete the dir on JVM exit (default true).
:dir - directory to create the dir in (default is the system temp dir).
       Must be of type that can be passed to clojure.java.io/dir.
:prefix - a string that is used to name the directory.
raw docstring

make-temp-pathclj

(make-temp-path options-or-prefix)

Return a temporary file path.

The options map can pass the keys:

:delete-on-exit - delete the file on JVM exit (default false) :dir - the directory in which to create the file (defaults to the system temp dir). Must be a path-like. :prefix - prefix for the file name (default "tmp"). Must be at elast three characters long. :suffix - suffix for the file name (default ".tmp")

As a shortcut, a prefix string can be passed instead of the options mao.

Return a temporary file path.

The options map can pass the keys:

:delete-on-exit - delete the file on JVM exit (default false)
:dir - the directory in which to create the file (defaults to the system temp dir).
       Must be a path-like.
:prefix - prefix for the file name (default "tmp").
          Must be at elast three characters long.
:suffix - suffix for the file name (default ".tmp")

As a shortcut, a prefix string can be passed instead of the options mao.
raw docstring

mkdirsclj

(mkdirs path-like)

Ensure the given path exists.

Ensure the given path exists.
raw docstring

real-pathclj

(real-path path-like)

with-temp-dircljmacro

(with-temp-dir bindings & body)

bindings => [name prefix-or-options ...]

Evaluate body with names bound to java.io.File objects of newly created temporary directories, and a finally clause that deletes them recursively in reverse order.

Prefix is a string that is used to name the directory. Options is a map with the keys: :delete-on-exit - delete the dir on JVM exit (default true) :dir - directory to create the dir in (default is the system temp dir). Must be of type that can be passed to clojure.java.io/dir. :prefix - a string that is used to name the directory.

bindings => [name prefix-or-options ...]

Evaluate body with names bound to java.io.File
objects of newly created temporary directories, and a finally clause
that deletes them recursively in reverse order.

Prefix is a string that is used to name the directory.
Options is a map with the keys:
:delete-on-exit - delete the dir on JVM exit (default true)
:dir - directory to create the dir in (default is the system temp dir).
       Must be of type that can be passed to clojure.java.io/dir.
:prefix - a string that is used to name the directory.
raw docstring

with-temp-pathcljmacro

(with-temp-path [sym prefix-or-options & more :as bindings] & body)

A scope with sym bound to a java.io.File object for a temporary file in the system's temporary directory.

Options is a map with the keys:

:delete - delete file when leaving scope (default true) :delete-on-exit - delete the file on JVM exit (default false) :dir - directory to create the file in (default is the system temp dir). Must be of type that can be passed to clojure.java.io/file. :prefix - prefix for the file name (default "tmp") Must be at elast three characters long. :suffix - suffix for the file name (default ".tmp")

A scope with sym bound to a java.io.File object for a temporary
file in the system's temporary directory.

Options is a map with the keys:

:delete - delete file when leaving scope (default true)
:delete-on-exit - delete the file on JVM exit (default false)
:dir - directory to create the file in (default is the system temp dir).
       Must be of type that can be passed to clojure.java.io/file.
:prefix - prefix for the file name (default "tmp")
          Must be at elast three characters long.
:suffix - suffix for the file name (default ".tmp")
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close