Liking cljdoc? Tell your friends :D

dk.simongray.id3.diagnostics

Every diagnostic that reading an ID3v2 tag can report, by id, with its level and meaning.

A diagnostic is a map of an :id, a :level and a :message, plus details such as the id of the :frame. The ids are part of the API, since apps match on them. An app with a catalogue of its own can add this one to it.

Most diagnostics are quirks: accommodations for tags that break the spec. A reading applies every quirk that its :except option doesn't name. The others say what couldn't be parsed, and where a reading stopped at one of its limits. A reading notes the same diagnostic once.

Every diagnostic that reading an ID3v2 tag can report, by id, with its
level and meaning.

A diagnostic is a map of an :id, a :level and a :message, plus details
such as the id of the :frame. The ids are part of the API, since apps
match on them. An app with a catalogue of its own can add this one to
it.

Most diagnostics are quirks: accommodations for tags that break the
spec. A reading applies every quirk that its :except option doesn't
name. The others say what couldn't be parsed, and where a reading
stopped at one of its limits. A reading notes the same diagnostic
once.
raw docstring

by-idclj/s

The catalogue by id.

The catalogue by id.
sourceraw docstring

catalogueclj/s

The diagnostics of a reading, in the order they tend to arise.

The diagnostics of a reading, in the order they tend to arise.
sourceraw docstring

contextclj/s

(context {:keys [except] :as opts})

A reading context for the opts of a reading. It collects the diagnostics of the reading, holds the quirks that the :except of opts turns off, and counts what the limits of opts limit.

A reading context for the `opts` of a reading. It collects the
diagnostics of the reading, holds the quirks that the :except of `opts`
turns off, and counts what the limits of `opts` limit.
sourceraw docstring

describeclj/s

(describe diagnostic)

The diagnostic with a :level and a :message: its own, or else those that the catalogue gives for its id.

The `diagnostic` with a :level and a :message: its own, or else those
that the catalogue gives for its id.
sourceraw docstring

limit-diagnosticsclj/s

The diagnostic that a reading notes when it reaches each limit of its options.

The diagnostic that a reading notes when it reaches each limit of its
options.
sourceraw docstring

note!clj/s

(note! ctx id)
(note! ctx id details)

Note the diagnostic id with the details in the reading context ctx, unless the context noted the same one already.

Note the diagnostic `id` with the `details` in the reading context
`ctx`, unless the context noted the same one already.
sourceraw docstring

notedclj/s

(noted ctx)

The diagnostics that the reading context ctx noted, in order.

The diagnostics that the reading context `ctx` noted, in order.
sourceraw docstring

quirk?clj/s

(quirk? ctx id)

Whether the quirk id is on in the reading context ctx, i.e. its :except doesn't name it.

Whether the quirk `id` is on in the reading context `ctx`, i.e. its
:except doesn't name it.
sourceraw docstring

unwritableclj/s

(unwritable message details)

An exception for a tag or frame that can't be written, with the message saying why and the details in its data, whose :type is :dk.simongray.id3/unwritable.

An exception for a tag or frame that can't be written, with the
`message` saying why and the `details` in its data, whose :type is
:dk.simongray.id3/unwritable.
sourceraw docstring

within-limit!clj/s

(within-limit! ctx k)

Count one more of what the limit k of the reading context ctx counts, and return whether the count is within the limit. Beyond it, the report says so, once.

Count one more of what the limit `k` of the reading context `ctx`
counts, and return whether the count is within the limit. Beyond it,
the report says so, once.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close