Documentation
¶
Overview ¶
Package regexp2 is a regexp package that has an interface similar to Go's framework regexp engine but uses a more feature full regex engine behind the scenes.
It doesn't have constant time guarantees, but it allows backtracking and is compatible with Perl5 and .NET. You'll likely be better off with the RE2 engine from the regexp package and should only use this if you need to write very complex patterns or require compatibility with .NET.
Index ¶
- Constants
- Variables
- func Escape(input string) string
- func Unescape(input string) (string, error)
- type Capture
- type Group
- type Match
- type MatchEvaluator
- type RegexOptions
- type Regexp
- func (re *Regexp) Debug() bool
- func (re *Regexp) FindNextMatch(m *Match) (*Match, error)
- func (re *Regexp) FindRunesMatch(r []rune) (*Match, error)
- func (re *Regexp) FindRunesMatchStartingAt(r []rune, startAt int) (*Match, error)
- func (re *Regexp) FindStringMatch(s string) (*Match, error)
- func (re *Regexp) FindStringMatchStartingAt(s string, startAt int) (*Match, error)
- func (re *Regexp) GetGroupNames() []string
- func (re *Regexp) GetGroupNumbers() []int
- func (re *Regexp) GroupNameFromNumber(i int) string
- func (re *Regexp) GroupNumberFromName(name string) int
- func (re *Regexp) MatchRunes(r []rune) (bool, error)
- func (re *Regexp) MatchString(s string) (bool, error)
- func (re *Regexp) Replace(input, replacement string, startAt, count int) (string, error)
- func (re *Regexp) ReplaceFunc(input string, evaluator MatchEvaluator, startAt, count int) (string, error)
- func (re *Regexp) RightToLeft() bool
- func (re *Regexp) String() string
Constants ¶
const ( None RegexOptions = 0x0 IgnoreCase = 0x0001 // "i" Multiline = 0x0002 // "m" ExplicitCapture = 0x0004 // "n" Compiled = 0x0008 // "c" Singleline = 0x0010 // "s" IgnorePatternWhitespace = 0x0020 // "x" RightToLeft = 0x0040 // "r" Debug = 0x0080 // "d" ECMAScript = 0x0100 // "e" RE2 = 0x0200 // RE2 (regexp package) compatibility mode )
Variables ¶
var DefaultMatchTimeout = time.Duration(math.MaxInt64)
Default timeout used when running regexp matches -- "forever"
Functions ¶
Types ¶
type Capture ¶
type Capture struct {
// the position in the original string where the first character of
// captured substring was found.
Index int
// the length of the captured substring.
Length int
// contains filtered or unexported fields
}
Capture is a single capture of text within the larger original string
type Group ¶
type Group struct {
Capture // the last capture of this group is embeded for ease of use
Name string // group name
Captures []Capture // captures of this group
}
Group is an explicit or implit (group 0) matched group within the pattern
type Match ¶
type Match struct {
Group //embeded group 0
// contains filtered or unexported fields
}
Match is a single regex result match that contains groups and repeated captures
-Groups -Capture
func (*Match) GroupByName ¶
GroupByName returns a group based on the name of the group, or nil if the group name does not exist
func (*Match) GroupByNumber ¶
GroupByNumber returns a group based on the number of the group, or nil if the group number does not exist
func (*Match) GroupCount ¶
GroupCount returns the number of groups this match has matched
type MatchEvaluator ¶
MatchEvaluator is a function that takes a match and returns a replacement string to be used
type RegexOptions ¶
type RegexOptions int32
RegexOptions impact the runtime and parsing behavior for each specific regex. They are setable in code as well as in the regex pattern itself.
type Regexp ¶
type Regexp struct {
//timeout when trying to find matches
MatchTimeout time.Duration
// contains filtered or unexported fields
}
Regexp is the representation of a compiled regular expression. A Regexp is safe for concurrent use by multiple goroutines.
func Compile ¶
func Compile(expr string, opt RegexOptions) (*Regexp, error)
Compile parses a regular expression and returns, if successful, a Regexp object that can be used to match against text.
func MustCompile ¶
func MustCompile(str string, opt RegexOptions) *Regexp
MustCompile is like Compile but panics if the expression cannot be parsed. It simplifies safe initialization of global variables holding compiled regular expressions.
func (*Regexp) FindNextMatch ¶
FindNextMatch returns the next match in the same input string as the match parameter. Will return nil if there is no next match or if given a nil match.
func (*Regexp) FindRunesMatch ¶
FindRunesMatch searches the input rune slice for a Regexp match
func (*Regexp) FindRunesMatchStartingAt ¶
FindRunesMatchStartingAt searches the input rune slice for a Regexp match starting at the startAt index
func (*Regexp) FindStringMatch ¶
FindStringMatch searches the input string for a Regexp match
func (*Regexp) FindStringMatchStartingAt ¶
FindStringMatchStartingAt searches the input string for a Regexp match starting at the startAt index
func (*Regexp) GetGroupNames ¶
GetGroupNames Returns the set of strings used to name capturing groups in the expression.
func (*Regexp) GetGroupNumbers ¶
GetGroupNumbers returns the integer group numbers corresponding to a group name.
func (*Regexp) GroupNameFromNumber ¶
GroupNameFromNumber retrieves a group name that corresponds to a group number. It will return "" for and unknown group number. Unnamed groups automatically receive a name that is the decimal string equivalent of its number.
func (*Regexp) GroupNumberFromName ¶
GroupNumberFromName returns a group number that corresponds to a group name. Returns -1 if the name is not a recognized group name. Numbered groups automatically get a group name that is the decimal string equivalent of its number.
func (*Regexp) MatchRunes ¶
MatchRunes return true if the runes matches the regex error will be set if a timeout occurs
func (*Regexp) MatchString ¶
MatchString return true if the string matches the regex error will be set if a timeout occurs
func (*Regexp) Replace ¶
Replace searches the input string and replaces each match found with the replacement text. Count will limit the number of matches attempted and startAt will allow us to skip past possible matches at the start of the input (left or right depending on RightToLeft option). Set startAt and count to -1 to go through the whole string
func (*Regexp) ReplaceFunc ¶
func (re *Regexp) ReplaceFunc(input string, evaluator MatchEvaluator, startAt, count int) (string, error)
ReplaceFunc searches the input string and replaces each match found using the string from the evaluator Count will limit the number of matches attempted and startAt will allow us to skip past possible matches at the start of the input (left or right depending on RightToLeft option). Set startAt and count to -1 to go through the whole string.
Source Files
Directories