Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://clojure.github.io/tools.reader/index.html below:

clojure.tools.reader - tools.reader 1.3.7-SNAPSHOT API documentation

Full namespace name:

A clojure reader in clojure

Map from ns alias to ns, if non-nil, it will be used to resolve read-time
ns aliases instead of (ns-aliases *ns*).

Defaults to nil

Map from reader tag symbols to data reader Vars.
Reader tags without namespace qualifiers are reserved for Clojure.
Default reader tags are defined in clojure.tools.reader/default-data-readers
and may be overridden by binding this Var.

When no data reader is found for a tag and *default-data-reader-fn*
is non-nil, it will be called with two arguments, the tag and the value.
If *default-data-reader-fn* is nil (the default value), an exception
will be thrown for the unknown tag.

Defaults to true.

***WARNING***
This setting implies that the full power of the reader is in play,
including syntax that can cause code to execute. It should never be
used with untrusted sources. See also: clojure.tools.reader.edn/read.

When set to logical false in the thread-local binding,
the eval reader (#=) and *record/type literal syntax* are disabled in read/load.
Example (will fail): (binding [*read-eval* false] (read-string "#=(* 2 21)"))

When set to :unknown all reads will fail in contexts where *read-eval*
has not been explicitly bound to either true or false. This setting
can be a useful diagnostic tool to ensure that all of your reads
occur in considered contexts.

Default map of data reader functions provided by Clojure.
May be overridden by binding *data-readers*

Usage: (map-func coll)

Decide which map type to use, array-map if less than 16 elements

Usage: (read)
       (read reader)
       (read opts reader)
       (read reader eof-error? eof-value)

Reads the first object from an IPushbackReader or a java.io.PushbackReader.
Returns the object read. If EOF, throws if eof-error? is true.
Otherwise returns sentinel. If no stream is provided, *in* will be used.

Opts is a persistent map with valid keys:
 :read-cond - :allow to process reader conditionals, or
              :preserve to keep all branches
 :features - persistent set of feature keywords for reader conditionals
 :eof - on eof, return value unless :eofthrow, then throw.
        if not specified, will throw

***WARNING***
Note that read can execute code (controlled by *read-eval*),
and as such should be used only with trusted sources.

To read data structures only, use clojure.tools.reader.edn/read

Note that the function signature of clojure.tools.reader/read and
clojure.tools.reader.edn/read is not the same for eof-handling

Usage: (read+string)
       (read+string stream)
       (read+string stream eof-error? eof-value)
       (read+string opts stream)

Like read, and taking the same args. reader must be a SourceLoggingPushbackReader.
Returns a vector containing the object read and the (whitespace-trimmed) string read.

Usage: (read-string s)
       (read-string opts s)

Reads one object from the string s.
Returns nil when s is nil or empty.

***WARNING***
Note that read-string can execute code (controlled by *read-eval*),
and as such should be used only with trusted sources.

To read data structures only, use clojure.tools.reader.edn/read-string

Note that the function signature of clojure.tools.reader/read-string and
clojure.tools.reader.edn/read-string is not the same for eof-handling

Usage: (resolve-symbol s)

Resolve a symbol s into its fully qualified namespace version

Usage: (syntax-quote form)

Macro equivalent to the syntax-quote reader macro (`).

An EDN reader in clojure

Usage: (read)
       (read reader)
       (read {:keys [eof], :as opts} reader)
       (read reader eof-error? eof opts)

Reads the first object from an IPushbackReader or a java.io.PushbackReader.
Returns the object read. If EOF, throws if eof-error? is true otherwise returns eof.
If no reader is provided, *in* will be used.

Reads data in the edn format (subset of Clojure data):
http://edn-format.org

clojure.tools.reader.edn/read doesn't depend on dynamic Vars, all configuration
is done by passing an opt map.

opts is a map that can include the following keys:
:eof - value to return on end-of-file. When not supplied, eof throws an exception.
:readers  - a map of tag symbols to data-reader functions to be considered before default-data-readers.
           When not supplied, only the default-data-readers will be used.
:default - A function of two args, that will, if present and no reader is found for a tag,
           be called with the tag and the value.

Usage: (read-string s)
       (read-string opts s)

Reads one object from the string s.
Returns nil when s is nil or empty.

Reads data in the edn format (subset of Clojure data):
http://edn-format.org

opts is a map as per clojure.tools.reader.edn/read

Usage: (number-literal? reader initch)

Checks whether the reader is at the start of a number literal

Usage: (parse-symbol token)

Parses a string into a vector of the namespace and symbol

Usage: (read-past pred rdr)

Read until first character that doesn't match pred, returning
char.

Usage: (skip-line reader)

Advances the reader to the end of a line. Returns the reader

Usage: (eof-error rdr & msgs)

Throws an ExceptionInfo with the given message.
If rdr is an IndexingReader, additional information about column and line number is provided

Usage: (illegal-arg-error rdr & msgs)

Throws an ExceptionInfo with the given message.
If rdr is an IndexingReader, additional information about column and line number is provided

Usage: (reader-error rdr & msgs)

Throws an ExceptionInfo with the given message.
If rdr is an IndexingReader, additional information about column and line number is provided

Usage: (inspect x)
       (inspect truncate x)

Return a string description of the value supplied.
May be the a string version of the value itself (e.g. "true")
or it may be a description (e.g. "an instance of Foo").
If truncate is true then return a very terse version of
the inspection.

Protocols and default Reader types implementation

Known implementations:

Usage: (unread reader ch)

Pushes back a single character on to the stream

Known implementations:

Usage: (get-column-number reader)

Returns the column number of the next character to be read from the stream

Usage: (get-file-name reader)

Returns the file name the reader is reading from, or nil

Usage: (get-line-number reader)

Returns the line number of the next character to be read from the stream

Known implementations:

Usage: (peek-char reader)

Returns the next char from the Reader without removing it from the reader stream

Usage: (read-char reader)

Returns the next char from the Reader, nil if the end of stream has been reached

Fields:

Protocols:

Interfaces:

Fields:

Protocols:

Interfaces:

Fields:

Protocols:

Interfaces:

Fields:

Protocols:

Interfaces:

Fields:

Protocols:

Interfaces:

Usage: (->IndexingPushbackReader rdr line column line-start? prev prev-column file-name normalize?)

Positional factory function for class clojure.tools.reader.reader_types.IndexingPushbackReader.

Usage: (->InputStreamReader is buf)

Positional factory function for class clojure.tools.reader.reader_types.InputStreamReader.

Usage: (->PushbackReader rdr buf buf-len buf-pos)

Positional factory function for class clojure.tools.reader.reader_types.PushbackReader.

Usage: (->SourceLoggingPushbackReader rdr line column line-start? prev prev-column file-name source-log-frames normalize?)

Positional factory function for class clojure.tools.reader.reader_types.SourceLoggingPushbackReader.

Usage: (->StringReader s s-len s-pos)

Positional factory function for class clojure.tools.reader.reader_types.StringReader.

Usage: (indexing-push-back-reader s-or-rdr)
       (indexing-push-back-reader s-or-rdr buf-len)
       (indexing-push-back-reader s-or-rdr buf-len file-name)

Creates an IndexingPushbackReader from a given string or PushbackReader

Usage: (indexing-reader? rdr)

Returns true if the reader satisfies IndexingReader

Usage: (input-stream-push-back-reader is)
       (input-stream-push-back-reader is buf-len)

Creates a PushbackReader from a given InputStream

Usage: (input-stream-reader is)

Creates an InputStreamReader from an InputStream

Usage: (line-start? rdr)

Returns true if rdr is an IndexingReader and the current char starts a new line

Usage: (log-source reader & body)

If reader is a SourceLoggingPushbackReader, execute body in a source
logging context. Otherwise, execute body, returning the result.

Usage: (merge-meta obj m)

Returns an object of the same type and value as `obj`, with its
metadata merged over `m`.

Usage: (push-back-reader rdr)
       (push-back-reader rdr buf-len)

Creates a PushbackReader from a given reader or string

Usage: (read-line)
       (read-line rdr)

Reads a line from the reader or from *in* if no reader is specified

Usage: (source-logging-push-back-reader s-or-rdr)
       (source-logging-push-back-reader s-or-rdr buf-len)
       (source-logging-push-back-reader s-or-rdr buf-len file-name)

Creates a SourceLoggingPushbackReader from a given string or PushbackReader

Usage: (string-push-back-reader s)
       (string-push-back-reader s buf-len)

Creates a PushbackReader from a given string

Usage: (string-reader s)

Creates a StringReader from a given string

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4