Liking cljdoc? Tell your friends :D

clj-string-layout.escape

Helpers for escaping cell values before rendering markup-oriented layouts.

The HTML and Markdown presets intentionally emit cell contents verbatim so callers can decide whether values are already trusted. Use this namespace to escape untrusted or arbitrary data before passing it to layout or layout-seq.

Helpers for escaping cell values before rendering markup-oriented layouts.

The HTML and Markdown presets intentionally emit cell contents verbatim so
callers can decide whether values are already trusted. Use this namespace to
escape untrusted or arbitrary data before passing it to layout or layout-seq.
raw docstring

csv-cellclj

(csv-cell value)

Escapes a value for an RFC 4180-style CSV cell.

nil is treated as an empty string and all other values are coerced with str. Values containing comma, double quote, CR, or LF are wrapped in double quotes, and embedded double quotes are doubled.

Escapes a value for an RFC 4180-style CSV cell.

nil is treated as an empty string and all other values are coerced with str.
Values containing comma, double quote, CR, or LF are wrapped in double quotes,
and embedded double quotes are doubled.
sourceraw docstring

htmlclj

(html value)

Escapes a value for HTML text content inside table cells.

nil is treated as an empty string and all other values are coerced with str. Escapes &, <, >, double quote, and single quote. This helper is intended for text content, not for constructing HTML attributes or URLs.

Escapes a value for HTML text content inside table cells.

nil is treated as an empty string and all other values are coerced with str.
Escapes &, <, >, double quote, and single quote. This helper is intended for
text content, not for constructing HTML attributes or URLs.
sourceraw docstring

log-safeclj

(log-safe value)

Escapes a value for single-line log output.

nil is treated as an empty string and all other values are coerced with str. Backslashes, tabs, line breaks, ISO control characters, and Unicode line/paragraph separators are rendered as visible escape sequences.

Escapes a value for single-line log output.

nil is treated as an empty string and all other values are coerced with str.
Backslashes, tabs, line breaks, ISO control characters, and Unicode
line/paragraph separators are rendered as visible escape sequences.
sourceraw docstring

map-cell-seqclj

(map-cell-seq f rows)

Lazily applies f to every cell in rows.

Each realized row is returned as a vector, so the result can be passed directly to layout-seq for large data sets. The outer sequence is lazy; each row is transformed when that row is consumed.

Lazily applies f to every cell in rows.

Each realized row is returned as a vector, so the result can be passed directly
to layout-seq for large data sets. The outer sequence is lazy; each row is
transformed when that row is consumed.
sourceraw docstring

map-cellsclj

(map-cells f rows)

Applies f eagerly to every cell in rows.

Returns a vector of row vectors suitable for layout, layout-str, or other eager consumers. Use map-cell-seq instead when the input is large or lazy.

Applies f eagerly to every cell in rows.

Returns a vector of row vectors suitable for layout, layout-str, or other
eager consumers. Use map-cell-seq instead when the input is large or lazy.
sourceraw docstring

markdown-cellclj

(markdown-cell value)

Escapes a value for a Markdown table cell.

nil is treated as an empty string and all other values are coerced with str. Backslashes and pipes are escaped, and CR/LF line breaks are rendered as <br>. This keeps generated Markdown tables structurally valid when cell values contain table delimiters or line breaks.

Escapes a value for a Markdown table cell.

nil is treated as an empty string and all other values are coerced with str.
Backslashes and pipes are escaped, and CR/LF line breaks are rendered as
<br>. This keeps generated Markdown tables structurally valid when cell values
contain table delimiters or line breaks.
sourceraw docstring

org-cellclj

(org-cell value)

Escapes a value for an Org mode table cell.

nil is treated as an empty string and all other values are coerced with str. Pipes are rendered as \vert{} and CR/LF line breaks are rendered as <br> so values cannot split the table structure.

Escapes a value for an Org mode table cell.

nil is treated as an empty string and all other values are coerced with str.
Pipes are rendered as `\vert{}` and CR/LF line breaks are rendered as `<br>` so
values cannot split the table structure.
sourceraw docstring

rst-cellclj

(rst-cell value)

Escapes a value for a reStructuredText simple-table cell.

nil is treated as an empty string and all other values are coerced with str. Backslashes are doubled and CR/LF line breaks are collapsed to spaces so values stay inside one physical table row.

Escapes a value for a reStructuredText simple-table cell.

nil is treated as an empty string and all other values are coerced with str.
Backslashes are doubled and CR/LF line breaks are collapsed to spaces so values
stay inside one physical table row.
sourceraw docstring

tsv-cellclj

(tsv-cell value)

Escapes a value for a single-line TSV cell.

nil is treated as an empty string and all other values are coerced with str. Backslashes, tabs, CR, and LF are rendered as visible backslash escapes so cell values cannot add columns or rows to the generated TSV output.

Escapes a value for a single-line TSV cell.

nil is treated as an empty string and all other values are coerced with str.
Backslashes, tabs, CR, and LF are rendered as visible backslash escapes so cell
values cannot add columns or rows to the generated TSV output.
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