clj-foundation.io — coconutpalm/clj-foundation 0.10.0

io address three primary concerns:

• Smoothing necessary Java interop for IO operations, particularly between strings and streams/writers
• Extending clojure.java.io to allow specifying an environment variable to use as the input source
• (de)Serializing Clojure data structures

bin-deserialize clj

(bin-deserialize filename)

bin-serialize clj

(bin-serialize filename o)

ByteArray clj

clojure-file-inputs clj

The data types allowed as input to io/input-stream

ClojureFileInputs clj

The set of types Clojure allows for opening files/streams

deserialize clj

(deserialize filename)

EnvironmentVariable clj

The name of a java system variable or O/S environment variable (in that order) that may override a ResourcePath.

ExtendedFileInputs clj

Clojure's file inputs plus extensions for reading from either Jar resources or Files.

input-stream clj

(input-stream file-input)

Inputs: [file-input :- ExtendedFileInputs] Returns: InputStream

Read and return a text file as an InputStream. Supported sources are the same as io/input-stream, with the following additions: ResourceOverrideMap and ResourceOverrideVector. See: (doc schema-name) for more information on these schema types.

normalize-file-input clj

(normalize-file-input file-input)

Inputs: [file-input :- ExtendedFileInputs] Returns: ClojureFileInputs

If the file-input is a string and can be converted to a resource URL, return that. If the file-input is a FileLocation, translate the :resource string to a URL and return that, otherwise return a File object wrapping the :file entry. Otherwise, return the original file-input.

print-writer clj macro

(print-writer stream thing)

Print thing to writer

println-writer clj macro

(println-writer stream thing)

Println thing to writer

read-file clj

(read-file file-input)

Inputs: [file-input :- ExtendedFileInputs] Returns: s/Str

Read and return a text file as a String. Supported sources are the same as io/input-stream, with the following additions: ResourceOverrideMap and ResourceOverrideVector. See: (doc schema-name) for more information on these types.

read-template clj

(read-template file-location & ex-substitutions)

Inputs: [file-location :- ExtendedFileInputs & ex-substitutions] Returns: s/Str

Read a file from file-location, applying any variable substitutions specified in the file using the keyword/value pairs in substitutions.

Supported sources are the same as io/input-stream, with the following additions: ResourceOverrideMap and ResourceOverrideVector. See: (doc schema-name) and (explain schema-name) for more information on these types.

resource-as-string clj

(resource-as-string & resource-spec)

Inputs: [& resource-spec :- [s/Str]] Returns: s/Str

1-arg variant: Reads the specified classpath resource and returns its contents as a string. 2-arg variant: ["ENVAR" "resource-file.txt"] - Allows resource-file to be overridden as-in read-file.

ResourceOverrideMap clj

Read the file specified by :file or the resource specified by :resource. If both entries are defined, the :file entry takes precedence over the :resource entry.

ResourceOverrideVector clj

Read the resource at ResourcePath unless a Java system variable or an O/S EnvironmentVariable is present with the specified name. In that case, use the value referenced by EnvironmentVariable as a file system path to the actual file.

ResourcePath clj

A path to a JAR file resource on the classapth.

serialize clj

(serialize filename data-structure)

Print a data structure to a file so that we may read it in later.

string-input-stream clj

(string-input-stream input)

Inputs: [input :- s/Str] Returns: InputStream

Return a java.io.InputStream containing the input string

string-output-writer clj

(string-output-writer)

Create a java.io.PrintWriter whose .toString contains the data printed to it.

with-err-str clj macro

(with-err-str & body)

Anything printed within body to err will be returned as a string.

with-out-writer clj macro

(with-out-writer f & body)

Opens a writer on f, binds it to out, and evaluates body. Anything printed within body will be written to f.