Packages
gleam_stdlib
0.10.1
1.0.3
1.0.2
1.0.1
1.0.0
0.71.0
0.70.0
0.69.0
0.68.1
0.68.0
0.67.1
0.67.0
0.65.0
0.64.0
0.63.2
0.63.1
0.63.0
0.62.1
0.62.0
0.61.0
0.60.0
0.59.0
0.58.0
0.57.0
0.56.0
0.55.0
0.54.0
0.53.0
0.52.0
0.51.0
0.50.0
0.49.0
0.48.0
0.47.0
0.46.0
0.45.0
0.44.0
0.43.0
0.42.0
0.41.0
0.40.0
0.39.0
0.38.0
0.37.0
0.36.0
0.35.1
0.35.0
0.34.0
0.33.1
0.33.0
0.32.1
0.32.0
0.31.0
0.30.2
0.30.1
0.30.0
0.29.2
0.29.1
0.29.0
0.28.2
0.28.1
0.28.0
0.27.0
0.26.1
0.26.0
0.25.0
0.24.0
0.23.0
0.22.3
0.22.2
0.22.1
0.22.0
0.21.0
0.20.0
0.19.3
0.19.2
0.19.1
0.19.0
0.18.1
0.18.0
0.18.0-rc1
0.17.1
0.17.0
0.16.0
0.15.0
0.14.0
0.13.0
0.12.0
0.11.0
0.10.1
0.10.0
0.9.0
0.8.0
0.7.0
0.6.0
0.5.0
0.4.0
0.4.0-rc1
0.3.1
0.3.0
0.2.0
retired
A standard library for the Gleam programming language
Current section
Files
Jump to
Current section
Files
src/gleam/regex.gleam
//// This module contains regular expression matching functions for strings.
//// The matching algorithms of the library are based on the PCRE library, but not
//// all of the PCRE library is interfaced and some parts of the library go beyond
//// what PCRE offers. Currently PCRE version 8.40 (release date 2017-01-11) is used.
import gleam/option.{Option}
pub external type Regex
/// The details about a particular match:
///
pub type Match {
Match(
/// The full string of the match.
content: String,
/// The byte index of the match in the original string.
byte_index: Int,
/// A Regex can have subpatterns, sup-parts that are in parentheses.
submatches: List(Option(String)),
)
}
/// When a regular expression fails to compile:
///
pub type CompileError {
CompileError(
/// The problem encountered that caused the compilation to fail
error: String,
/// The byte index into the string to where the problem was found
byte_index: Int,
)
}
pub type Options {
Options(case_insensitive: Bool, multi_line: Bool)
}
/// Create a Regex with some additional options.
///
/// ## Examples
///
/// > let options = Options(case_insensitive: False, multi_line: True)
/// > assert Ok(re) = compile("^[0-9]", with: options)
/// > match(re, "abc\n123")
/// True
///
/// > let options = Options(case_insensitive: True, multi_line: False)
/// > assert Ok(re) = compile("[A-Z]", with: options)
/// > match(re, "abc123")
/// True
///
pub external fn compile(String, with: Options) -> Result(Regex, CompileError) =
"gleam_stdlib" "compile_regex"
/// Create a new Regex.
///
/// ## Examples
///
/// > assert Ok(re) = from_string("[0-9]")
/// > match(re, "abc123")
/// True
///
/// > match(re, "abcxyz")
/// False
///
/// > from_string("[0-9")
/// Error(
/// CompileError(
/// error: "missing terminating ] for character class",
/// byte_index: 4
/// )
/// )
///
pub fn from_string(pattern: String) -> Result(Regex, CompileError) {
compile(pattern, Options(case_insensitive: False, multi_line: False))
}
/// Returns a boolean indicating whether there was a match or not.
///
/// ## Examples
///
/// > assert Ok(re) = from_string("^f.o.?")
/// > check(with: re, content: "foo")
/// True
///
/// > check(with: re, content: "boo")
/// False
///
pub external fn check(with: Regex, content: String) -> Bool =
"gleam_stdlib" "regex_match"
/// Split a string
///
/// ## Examples
///
/// > assert Ok(re) = from_string(" *, *")
/// > split(with: re, content: "foo,32, 4, 9 ,0")
/// ["foo", "32", "4", "9", "0"]
///
pub external fn split(with: Regex, content: String) -> List(String) =
"gleam_stdlib" "regex_split"
/// Collects all matches of the regular expression.
///
/// ## Examples
///
/// > assert Ok(re) = regex.from_string("[oi]n a (\\w+)")
/// > regex.scan(with: re, content: "I am on a boat in a lake.")
/// [
/// Match(
/// content: "on a boat",
/// byte_index: 5,
/// submatches: [Some("boat")]
/// ),
/// Match(
/// content: "in a lake",
/// byte_index: 15,
/// submatches: [Some("lake")]
/// )
/// ]
///
pub external fn scan(with: Regex, content: String) -> List(Match) =
"gleam_stdlib" "regex_scan"