ike.cljj.file — org.ajoberstar/ike.cljj 0.4.1

A straightforward wrapper of common java.nio.file.* functionality. All functions use the Pathish protocol to turn their arguments into Paths.

copy clj

(copy from to & {:as opts})

Copies a file or directory. Options include: :recurse true to copy all files underneath the directory (default false)

delete clj

(delete path & {:as opts})

Deletes a file or directory. Will not fail if the path does not exist. Options include: :recurse true to copy all files underneath the directory (default false)

dir? clj

(dir? path)

Tests whether the path is a directory.

exists? clj

(exists? path)

Tests whether the path exists.

extension clj

(extension path)

Gets the extension of the path, if any. Nil returned if there is no extension.

file? clj

(file? path)

Tests whether the path is a file.

lines clj

(lines path & {:as opts})

Lazily reads lines from a file and returns them in a Stream. Be sure to use this in a with-open or use reduce/transducers to close the file.

;; just read first line (with-open [lines (file/lines path)] (first (stream/stream-seq lines)))

;; just read first character of each line (into [] (map first) (file/lines path))

Options include: :encoding string name of charset (as supported by Charset/forName) (default "UTF-8")

link? clj

(link? path)

Tests whether the path is a symbolic link.

list clj

(list path)

Lists the immediate children of a directory. Be sure to use this in a with-open or use reduce/transducers to close the stream.

;; just read first child (with-open [children (file/list path)] (first (stream/stream-seq children)))

;; just read the name of each file (into [] (map .getFileName) (file/list path))

make-dir clj

(make-dir path)

Creates an empty directory at the path. Parents must exist already.

make-dirs clj

(make-dirs path)

Creates an empty directory at the path, including any parent directories, if they don't already exist.

make-file clj

(make-file path)

Creates an empty file at the path.

make-link clj

(make-link path target)

Creates a symbolic link from 'path' to 'target'.

make-parents clj

(make-parents path)

Creates parent directories of the path, if they don't already exist.

move clj

(move path target & {:as opts})

Moves the file or directory from 'path' to 'target'.

path clj

(path x & more)

Creates a Path using the segments provided.

Pathish clj protocol

Implement this protocl if your type can be converted to a java.nio.file.Path object.

as-path clj

(as-path x)

read-bytes clj

(read-bytes path)

Reads all bytes from a file and returns the byte[].

read-lines clj

(read-lines path & {:as opts})

Reads all lines from a file and returns them as a List. Options include: :encoding string name of charset (as supported by Charset/forName) (default "UTF-8")

read-link clj

(read-link path)

Reads the target of a symbolic link.

read-str clj

(read-str path & {:as opts})

Reads all bytes from a file and returns as a String. Options include: :encoding string name of charset (as supported by Charset/forName) (default "UTF-8")

same? clj

(same? x y)

Tests whether two paths point to the same file.

size clj

(size path)

Calculates the size of the file at the path.

temp-dir clj

(temp-dir prefix)

(temp-dir dir prefix)

Creates a temporary dir. Uses java.io.tmpdir as the parent folder unless 'dir' is provided.

temp-file clj

(temp-file prefix suffix)

(temp-file dir prefix suffix)

Creates a temporary file. Uses java.io.tmpdir as the parent folder unless 'dir' is provided.

walk clj

(walk path)

(walk path max-depth)

Walks the file tree (depth-first) below a directory, returning a Stream. The first element will always be the given path. Be sure to use this in a with-open or use reduce/transducers to close the stream.

;; just read first descendant (with-open [children (file/walk path)] (first (stream/stream-seq children)))

;; just read the name of each file (into [] (map .getFileName) (file/walk path))

write-bytes clj

(write-bytes path bytes & {:as opts})

Writes all bytes to a file (truncating any existing content). Options include: :append true to open file in append mode (default false, i.e. truncate)

write-lines clj

(write-lines path lines & {:as opts})

Writes all lines to a file. Options include: :append true to open file in append mode (default false, i.e. truncate) :encoding string name of charset (as supported by Charset/forName) (default "UTF-8")

write-str clj

(write-str path content & {:as opts})

Writes a String's bytes (as UTF-8) to to a file. Options include: :append true to open file in append mode (default false, i.e. truncate) :encoding string name of charset (as supported by Charset/forName) (default "UTF-8")