The public API of the library. Note that all methods will throw if the resulting regular expression is syntactically invalid.
The public API of the library. Note that all methods will throw if the resulting regular expression is syntactically invalid.
(=' _)
(=' re1 re2)
(=' re1 re2 & more)
Equality for regexes, defined by having equal String
representations. This
means that equivalent regexes (e.g. #"..."
and #".{3}"
will not be
considered equal.
Note: this is only needed in ClojureJVM (ClojureScript correctly implements equals on regexes).
Equality for regexes, defined by having equal `String` representations. This means that _equivalent_ regexes (e.g. `#"..."` and `#".{3}"` will _not_ be considered equal. Note: this is only needed in ClojureJVM (ClojureScript correctly implements equals on regexes).
(alt & res)
Returns a regex that will match any one of res
, via alternation. Does not
perform any grouping of the elements in res
- for that use [alt-grp].
Returns a regex that will match any one of `res`, via alternation. Does not perform any grouping of the elements in `res` - for that use [alt-grp].
(alt-grp & res)
[grp] on each element in res
, then [alt].
[grp] on each element in `res`, then [alt].
(and' a b)
(and' a b s)
Returns an 'and' regex that will match a
and b
in any order, and with the
s
eparator regex (if provided) between them. This is implemented as
ASB|BSA
, which means that A and B must be distinct (must not match each
other). Does not perform any grouping, ether on a
, b
, or s
- for that
use [and-grp].
Returns an 'and' regex that will match `a` and `b` in any order, and with the `s`eparator regex (if provided) between them. This is implemented as `ASB|BSA`, which means that A and B must be distinct (must not match each other). Does not perform any grouping, ether on `a`, `b`, or `s` - for that use [and-grp].
(and-grp a b)
(and-grp a b s)
[grp] around a
, b
and s
, then [and'].
[grp] around `a`, `b` and `s`, then [and'].
(cg & res)
As for [grp], but uses a capturing group.
As for [grp], but uses a capturing group.
(esc s)
Escapes s
(a String
) for use in a regex, returning a String
. Note that
unlike most other fns in this namespace, this one does not support a regex
as an input.
Escapes `s` (a `String`) for use in a regex, returning a `String`. Note that unlike most other fns in this namespace, this one does _not_ support a regex as an input.
(exn n re)
Returns a regex where re
will match exactly n
times. Does not perform any
grouping.
Returns a regex where `re` will match exactly `n` times. Does not perform any grouping.
(grp & res)
As for [join], but encloses the joined res
into a single non-capturing
group.
As for [join], but encloses the joined `res` into a single non-capturing group.
(join & res)
Returns a regex that is the res
joined together. Each element in res
can
be a regex, String
or something that can be turned into a String
. Returns
nil
if no res
are provided
Returns a regex that is the ` res` joined together. Each element in `res` can be a regex, `String` or something that can be turned into a `String`. Returns `nil` if no `res` are provided
(n2m n m re)
Returns a regex where re
will match from n
to m
times. Does not perform
any grouping.
Returns a regex where `re` will match from `n` to `m` times. Does not perform any grouping.
(ncg nm & res)
As for [grp], but uses a named capturing group named nm
. Returns nil
if
nm
is nil
or blank. Throws if nm
is an invalid name for a named capturing
group (alphanumeric only, must start with an alphabetical character, must be
unique within the regex).
As for [grp], but uses a named capturing group named `nm`. Returns `nil` if `nm` is `nil` or blank. Throws if `nm` is an invalid name for a named capturing group (alphanumeric only, must start with an alphabetical character, must be unique within the regex).
(nom n re)
Returns a regex where re
will match n
or more times. Does not perform any
grouping.
Returns a regex where `re` will match `n` or more times. Does not perform any grouping.
(oom re)
Returns a regex where re
will match one or more times. Does not perform any
grouping.
Returns a regex where `re` will match one or more times. Does not perform any grouping.
(opt re)
Returns a regex where re
is optional. Does not perform any grouping.
Returns a regex where `re` is optional. Does not perform any grouping.
(or' a b)
(or' a b s)
Returns an 'inclusive or' regex that will match a
or b
, or both, in any
order, and with the s
eparator regex (if provided) between them. This is
implemented as ASB|BSA|A|B
, which means that A and B must be distinct (must
not match each other). Does not perform any grouping, either on a
, b
, or
s
- for that use [or-grp].
Returns an 'inclusive or' regex that will match `a` or `b`, or both, in any order, and with the `s`eparator regex (if provided) between them. This is implemented as `ASB|BSA|A|B`, which means that A and B must be distinct (must not match each other). Does not perform any grouping, either on `a`, `b`, or `s` - for that use [or-grp].
(or-grp a b)
(or-grp a b s)
[grp] around a
, b
and s
, then [or'].
[grp] around `a`, `b` and `s`, then [or'].
(qot s)
Quotes s
(a String
) for use in a regex, returning a regex. Note that
unlike most other fns in this namespace, this one does not support a regex
as an input.
Quotes `s` (a `String`) for use in a regex, returning a regex. Note that unlike most other fns in this namespace, this one does _not_ support a regex as an input.
(zom re)
Returns a regex where re
will match zero or more times. Does not perform
any grouping.
Returns a regex where `re` will match zero or more times. Does not perform any grouping.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close