Matches any character. Equivalent to "."

Match any of the characters in a given character class, classes, or string - provided as opts.

The supported class names (provided with class: ..., or classes: [...]) are:

• :alnum - Letters and digits
• :alpha - Letters
• :ascii - Character codes 0-127
• :blank - Space or tab only
• :cntrl - Control characters
• :digit - Decimal digits (same as \d)
• :graph - Printing characters, excluding space
• :lower - Lowercase letters
• :print - Printing characters, including space
• :punct - Printing characters, excluding letters, digits, and space
• :space - Whitespace (the same as \s from PCRE 8.34)
• :upper - Uppercase letters
• :word - "Word" characters (same as \w)
• :xdigit - Hexadecimal digits

Examples

iex> alias Verbalex, as: Vlx
iex> "" |> Vlx.anything_in(class: :alnum, string: "._%+-") |> Vlx.one_or_more()
"[[:alnum:]._%+-]+"

iex> alias Verbalex, as: Vlx
iex> "" |> Vlx.anything_in(classes: [:lower, :punct])
"[[:lower:][:punct:]]"

Inverse of anything_in/2.

Wraps a regex string in a non-capturing group. This facilitates easy application of things like quantifiers or backreferences to the entirety of a given expression.

Examples

iex> alias Verbalex, as: Vlx
iex> protocol = Vlx.find("http") |> Vlx.maybe("s") |> Vlx.then("://") |> Vlx.atomize()
iex> Vlx.maybe(protocol) |> Vlx.then("www.")
"(?:(?:http)s?(?:://))?(?:www\\.)"

Wraps a regex string in a capturing group.

Examples

iex> alias Verbalex, as: Vlx
iex> pattern = Vlx.find("this") |> Vlx.then("that")
iex> Vlx.capture(pattern)
"((?:this)(?:that))"

Wraps a regex string in a named-capturing group. To be utilised with Regex.named_captures(regex, string, opts \\ []).

Examples

iex> alias Verbalex, as: Vlx
iex> Vlx.find("http") |> Vlx.maybe("s") |> Vlx.then("://") |> Vlx.capture_as("protocols")
"(?<protocols>(?:http)s?(?::\/\/))"

Matches a carriage return character. Equivalent to "\r".

Matches a digit (0-9). Equivalent to "\d".

Express the end of a line regex anchor. Translates to '$'.

Examples

iex> alias Verbalex, as: Vlx
iex> Vlx.find("far, far, away.") |> Vlx.end_of_line() |> Regex.compile!()
~r/(?:far,\ far,\ away\.)$/

Express a string literal to be matched exactly and wraps in a non-capturing group. Alias of then/3 for readability semantics, as 'find' is a makes more sense when placed at the beginning of a pipe chain.

NOTE: Under the current implementation, when using the escape: false option in pipe chains beginning with find, an empty string must be provided as the first value.

Examples

iex> alias Verbalex, as: Vlx
iex> Vlx.find("needle") |> Vlx.if_preceded_by("hay") |> Vlx.if_followed_by("stack")
"(?<=hay)(?:needle)(?=stack)"

Takes a regex string and applies a lookahead condition. Escapes special characters by default.

Examples

iex> alias Verbalex, as: Vlx
iex> Vlx.find("sentence") |> Vlx.if_followed_by(".") |> Vlx.capture()
"((?:sentence)(?=\\.))"

Takes a regex string and applies a negative lookahead condition. Escapes special characters by default.

Examples

iex> alias Verbalex, as: Vlx
iex> Vlx.find("good") |> Vlx.if_not_followed_by("bye") |> Vlx.capture()
"((?:good)(?!bye))"

Takes a regex string and applies a negative lookbehind condition. Escapes special characters by default.

Examples

iex> alias Verbalex, as: Vlx
iex> Vlx.digit() |> Vlx.if_not_preceded_by("%") |> Vlx.capture()
"((?<!%)\d)"

Takes a regex string and applies a lookbehind condition. Escapes special characters by default.

Examples

iex> alias Verbalex, as: Vlx
iex> Vlx.digit() |> Vlx.if_preceded_by("$") |> Vlx.capture()
"((?<=\\$)\d)"

Matches a linebreak character. Equivalent to "\n".

Express a pattern as being optional to match.

Examples

iex> alias Verbalex, as: Vlx
iex> Vlx.find("colo") |> Vlx.maybe("u") |> Vlx.then("r")
"(?:colo)u?(?:r)"

Matches anything but a digit (0-9). Equivalent to "\D".

Matches anything but whitespace character - includes tabs and line breaks.

Matches anything but a 'word', equivalent to [^a-zA-Z0-9_]

Specify the number of expected occurences to be found on a given expression.

Examples

iex> alias Verbalex, as: Vlx
iex> Vlx.digit() |> Vlx.capture() |> Vlx.occurs(4)
"(\d){4}"

Specify the minimum number of expected occurences to be found on a given expression.

Examples

iex> alias Verbalex, as: Vlx
iex> Vlx.digit() |> Vlx.capture() |> Vlx.occurs_at_least(2)
"(\d){2,}"

Specify the range of expected occurences to be found on a given expression.

Examples

iex> alias Verbalex, as: Vlx
iex> Vlx.digit() |> Vlx.capture() |> Vlx.occurs_in_range(3, 6)
"(\d){3,6}"

Express a pattern will occur one or more times.

Examples

iex> alias Verbalex, as: Vlx
iex> "" |> Vlx.anything_in(class: :alnum) |> Vlx.one_or_more()
"[[:alnum:]]+"

Takes in a list of regex strings, and inserts an or operator between each of them. Does not escape characters by default to preference OR-ing complex expressions and encourage composition. Special character escaping is available via the escape: true option.

Examples

iex> alias Verbalex, as: Vlx
iex> accepted_exprs = ["match", "any", "of", "these"]
iex> Vlx.or_expressions(accepted_exprs)
"(match|any|of|these)"

Express the start of a line regex anchor. Translates to '^'.

Examples

iex> alias Verbalex, as: Vlx
iex> Vlx.start_of_line() |> Vlx.find("A long time ago...") |> Regex.compile!()
~r/^(?:A\ long\ time\ ago\.\.\.)/

Matches a tab character. Equivalent to "\t".

Express a string literal to be matched exactly and wraps in a non-capturing group. Escapes special characters by default. Turn off character escapes with the escape: false option.

Examples

iex> alias Verbalex, as: Vlx
iex> Vlx.find("www.") |> Vlx.then("example.com")
"(?:www\\.)(?:example\\.com)"

Matches a whitespace character - includes tabs and line breaks.

Matches a 'word', equivalent to [a-zA-Z0-9_]

Matches a 'word boundary' - a word bounary is the position between a word and non-word character (0-9A-Za-z_]). It is commonly thought of as matching the beginning or end of a string.

Express a pattern will occur zero or more times.

Examples

iex> alias Verbalex, as: Vlx
iex> "" |> Vlx.anything_in(string: "#@$%", class: :alnum) |> Vlx.zero_or_more()
"[#@$%[:alnum:]]*"