Liking cljdoc? Tell your friends :D

grammar.schema

Value objects. Every other namespace speaks in these shapes.

Intent what the caller wants, language-neutral. Verdict tri-state truth of a capability: :yes, :no, :unknown. Evidence why a verdict (or a text constraint) holds: a probe run with its exit status and output, or an explicit declaration. Profile capabilities + text constraints + the evidence behind them. Result what the planner returns, always carrying its justification.

Value objects. Every other namespace speaks in these shapes.

Intent      what the caller wants, language-neutral.
Verdict     tri-state truth of a capability: :yes, :no, :unknown.
Evidence    why a verdict (or a text constraint) holds: a probe run with
            its exit status and output, or an explicit declaration.
Profile     capabilities + text constraints + the evidence behind them.
Result      what the planner returns, always carrying its justification.
raw docstring

ArgvWordclj

An exec argument: any string without NUL, which no argv entry can hold.

An exec argument: any string without NUL, which no argv entry can hold.
sourceraw docstring

CapEntryclj

source

EnsureDirclj

source

Evidenceclj

source

explain-intentclj

(explain-intent x)
source

explain-resultclj

(explain-result x)
source

http-url?clj

(http-url? s)

True for a string naming an http:// or https:// URL (scheme in lower case) with no ASCII control character. Every other scheme (file:, ftp:, ...) and every option-like word (a leading -) is refused, so no fetch tool can read it as anything but an http URL; a control character (CR LF above all) could split the HTTP request a fetch tool writes, so it is refused too.

True for a string naming an http:// or https:// URL (scheme in lower case)
with no ASCII control character. Every other scheme (file:, ftp:, ...) and
every option-like word (a leading -) is refused, so no fetch tool can read
it as anything but an http URL; a control character (CR LF above all) could
split the HTTP request a fetch tool writes, so it is refused too.
sourceraw docstring

HttpGetclj

source

HttpUrlclj

A URL an :http-get fetches: http:// or https://, no control characters.

A URL an :http-get fetches: http:// or https://, no control characters.
sourceraw docstring

Intentclj

source

intent?clj

(intent? x)
source

Langclj

A target language: :sh, :python, or any language a module registers (see grammar.core/modules). Open, so a new language is data, not a schema edit.

A target language: :sh, :python, or any language a module registers
(see grammar.core/modules). Open, so a new language is data, not a schema
edit.
sourceraw docstring

PathArgclj

A filesystem path an operation acts on: non-empty, no NUL.

A filesystem path an operation acts on: non-empty, no NUL.
sourceraw docstring

Profileclj

source

profile?clj

(profile? x)
source

RemoveFileclj

source

Resultclj

source

result?clj

(result? x)
source

Runclj

source

Strclj

source

TextConstraintsclj

source

Verdictclj

source

WriteFileclj

source

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