replacing(_:subrange:maxReplacements:with:)

Returns a new collection in which all occurrences of a sequence matching the given regex are replaced by another regex match.

iOS
16.0+
macOS
13.0+
tvOS
16.0+
watchOS
9.0+
func replacing<Output, Replacement>(_ regex: some RegexComponent, subrange: Range<Self.Index>, maxReplacements: Int = .max, with replacement: (Regex<Output>.Match) throws -> Replacement) rethrows -> Self where Replacement : Collection, Replacement.Element == Character

Parameters

regex

A regex describing the sequence to replace.

subrange

The range in the collection in which to search for regex.

maxReplacements

A number specifying how many occurrences of the sequence matching regex to replace. Default is Int.max.

replacement

A closure that receives the full match information, including captures, and returns a replacement collection.

Returns

A new collection in which all occurrences of subsequence matching regex are replaced by replacement.