Liking cljdoc? Tell your friends :D

hive-system.pattern.schema

Malli value objects for the pattern subsystem.

A Pattern is a portable, ENGINE-AGNOSTIC description of what to look for: an expression plus flags, optionally named by an id. A Match is one located occurrence — text plus its half-open [start end) offsets in the subject.

These schemas are the single source: they drive the m/=> contracts and the synthesized property/mutation tests.

Malli value objects for the pattern subsystem.

A Pattern is a portable, ENGINE-AGNOSTIC description of what to look for:
an expression plus flags, optionally named by an id. A Match is one located
occurrence — text plus its half-open [start end) offsets in the subject.

These schemas are the single source: they drive the `m/=>` contracts and the
synthesized property/mutation tests.
raw docstring

EngineIdclj/s

Stable keyword naming a registered engine (e.g. :regex, :structural).

Stable keyword naming a registered engine (e.g. :regex, :structural).
sourceraw docstring

Flagclj/s

Portable matching flag. Engines map these onto their own dialect and MUST ignore none silently — an unsupported flag is an error, not a no-op.

Portable matching flag. Engines map these onto their own dialect and MUST
ignore none silently — an unsupported flag is an error, not a no-op.
sourceraw docstring

Matchclj/s

One occurrence. :match/end is EXCLUSIVE. :match/groups holds capture groups in declaration order, nil for a group that did not participate.

One occurrence. :match/end is EXCLUSIVE. :match/groups holds capture groups
in declaration order, nil for a group that did not participate.
sourceraw docstring

Matchesclj/s

Occurrences in subject order, non-overlapping.

Occurrences in subject order, non-overlapping.
sourceraw docstring

Patternclj/s

What to look for. :pattern/engine absent means the caller's default engine.

:pattern/construct is present when the expression was PROJECTED from a regex construct (see hive-system.pattern.construct.api) rather than written as a literal. It records the source of :pattern/expr; nothing in the match path reads it.

What to look for. :pattern/engine absent means the caller's default engine.

:pattern/construct is present when the expression was PROJECTED from a
regex construct (see hive-system.pattern.construct.api) rather than written
as a literal. It records the source of :pattern/expr; nothing in the match
path reads it.
sourceraw docstring

PatternIndexclj/s

id -> Pattern. The registry's value; passed explicitly to pure resolvers.

id -> Pattern. The registry's value; passed explicitly to pure resolvers.
sourceraw docstring

PatternRefclj/s

A call site names a pattern by id or supplies one inline.

A call site names a pattern by id or supplies one inline.
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