API.md

Public API

There are four public namespaces:

• clojure.tools.reader.reader-types offers protocols, implementations and convenient function helpers for some reader types.
  • Protocols:
    • Reader (read-char, peek-char)
    • IPushbackReader (unread)
    • IndexingReader (get-line-number, get-column-number, get-file-name)
  • Types:
    • StringReader
    • PushbackReader
    • IndexingPushbackReader
    • InputStreamReader
    • SourceLoggingPushbackReader
  • Types Constructor Functions:
    • string-reader
    • string-push-back-reader
    • indexing-push-back-reader
    • input-stream-reader
    • input-stream-push-back-reader
    • source-logging-push-back-reader
  • Functions:
    • read-line
    • reader-error
  • Macros:
    • log-source
• clojure.tools.reader.edn offers a feature-complete EDN reader, whose API matches clojure.edn's one, those functions are safe.
  • Functions:
    • read
    • read-string
• clojure.tools.reader offers a feature-complete clojure reader, whose API matches clojure.core's one, those functions are unsafe and may allow code execution if not used properly.
  • Functions:
    • read
    • read-string
  • Macros:
    • syntax-quote
  • Vars:
    • *read-eval*
    • *data-readers*
    • *default-data-reader-fn*
    • default-data-readers
• clojure.tools.reader.default-data-readers offers implementations for the #inst and #uuid tagged literals, copied from the clojure source.

Refer to docstrings in each namespace and to the project's autodoc for more documentation.