Wild v1.0.0-rc.4 Wild View Source
Provides the interface to underlying wildcard implementations.
The match?/3
and valid_pattern?/1
functions support all of the usual
wildcard pattern mechanisms:
*
matches none or many tokens?
matches exactly one token[abc]
matches a set of tokens[a-z]
matches a range of tokens[!...]
matches anything but a set of tokens
Link to this section Summary
Functions
Executes a unix-style wildcard pattern match on a string with a given pattern. By default it tokenizes and runs on Codepoints but can also be set to Byte mode.
Checks if the given pattern is a valid unix-style wildcard pattern. The most
common invalid patterns arise because of invalid escape sequences. Mode can
be either :byte
or :codepoint
(default).
Link to this section Functions
Executes a unix-style wildcard pattern match on a string with a given pattern. By default it tokenizes and runs on Codepoints but can also be set to Byte mode.
Examples
iex> Wild.match?("foobar", "foo*")
true
iex> Wild.match?("foobar", "fo[a-z]bar")
true
iex> Wild.match?(<<9, 97, 98>>, "?ab")
true
iex> Wild.match?("foobar", "bar*")
false
iex> Wild.match?(<<16, 196, 130, 4>>, "????", mode: :byte)
true
The options are:
:mode
- The matching mode. This primarily affects tokenization and what is considered a single match for the?
wildcard. Options are::codepoint
(default) - Tokenize on printable String characters:byte
- Tokenize on each byte:bash
- Using an underlying bash script. Only for debugging
The distinction is important for subject and patterns like the following, where the binary is represented by two bytes but only one codepoint:
iex> Wild.match?("ā", "?", mode: :codepoint) true iex> Wild.match?("ā", "?", mode: :byte) false
The
:codepoint
mode usesString.codepoints/1
for tokenization, while the:byte
mode uses:binary.bin_to_list/1
. If we tokenize our"ā"
subject we can see the two functions produce different amounts of tokens:iex> String.codepoints("ā") ["ā"] iex> :binary.bin_to_list("ā") [196, 129]
If you are dealing with user input from forms this is likely not something you will encounter and can keep the default value of
:codepoint
.:on_pattern_error
- What to do when the pattern is invalid. The options are::fail
(default) - Simliar to case statements in Bash where an invalid pattern won't match the subject, simply fail the match and returnfalse
:return
- Returns an{:error, error}
tuple:raise
- Raise an error
Checks if the given pattern is a valid unix-style wildcard pattern. The most
common invalid patterns arise because of invalid escape sequences. Mode can
be either :byte
or :codepoint
(default).
Examples
iex> Wild.valid_pattern?("fo[a-z]b?r")
true
iex> Wild.valid_pattern?(<<?\\, ?a>>)
false
iex> Wild.valid_pattern?("hello", :codepoint)
true