wholeMatch(in:)

Declaration

func wholeMatch(in string: Substring) throws -> Regex<Output>.Match?

Parameters

• string:

  The substring to match this regular expression against.

Return Value

The match, if this regex matches the entirety of string; otherwise, nil.

Discussion

Call this method if you want the regular expression to succeed only when it matches the entire string you pass as string. The following example shows matching a regular expression that only matches digits, with different candidate strings.

let digits = /[0-9]+/

if let digitsMatch = try digits.wholeMatch(in: "2022") {
    print(digitsMatch.0)
} else {
    print("No match.")
}
// Prints "2022"

if let digitsMatch = try digits.wholeMatch(in: "The year is 2022.") {
    print(digitsMatch.0)
} else {
    print("No match.")
}
// Prints "No match."

The wholeMatch(in:) method can throw an error if this regex includes a transformation closure that throws an error.