Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aspiesoft/go-regex-re2
A performance improvement to the builtin RE2 module.
https://github.com/aspiesoft/go-regex-re2
go golang re2 regex regex-engine regexp
Last synced: about 2 months ago
JSON representation
A performance improvement to the builtin RE2 module.
- Host: GitHub
- URL: https://github.com/aspiesoft/go-regex-re2
- Owner: AspieSoft
- License: mit
- Created: 2023-08-28T17:06:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-15T20:18:48.000Z (about 1 year ago)
- Last Synced: 2024-04-30T07:16:06.917Z (9 months ago)
- Topics: go, golang, re2, regex, regex-engine, regexp
- Language: Go
- Homepage:
- Size: 38.1 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Go Regex RE2
[](https://paypal.me/shaynejrtaylor?country.x=US&locale.x=en_US)
A performance improvement to the builtin RE2 module.
This method adds a cache, and some better functions, and uses RE2 for compatability.
If you need more speed, checkout my other PCRE based module [go-regex](https://github.com/AspieSoft/go-regex).
## Installation
```shell script
go get github.com/AspieSoft/go-regex-re2/v2
```
## Usage
```go
import (
"github.com/AspieSoft/go-regex-re2/v2"
// or for verbose function names
"github.com/AspieSoft/go-regex-re2/v2/verbose"
)
// this example will use verbose mode to make function names more clear
// pre compile a regex into the cache
// this method also returns the compiled pcre.Regexp struct
regex.Compile(`re`)
// compile a regex and safely escape user input
regex.Compile(`re %1`, `this will be escaped .*`); // output: this will be escaped \.\*
regex.Compile(`re %1`, `hello \n world`); // output: hello \\n world (note: the \ was escaped, and the n is literal)
tree/v4.0.0
// use %n to reference a param
// use %{n} for param indexes with more than 1 digit
regex.Compile(`re %1 and %2 ... %{12}`, `param 1`, `param 2` ..., `param 12`);
// manually escape a string
// note: the compile methods params are automatically escaped
regex.Escape(`(.*)? \$ \\$ \\\$ regex hack blocked`)
// determine if a regex is valid, and can be compiled by this module
regex.IsValid(`re`)
// determine if a regex is valid, and can be compiled by the builtin RE2 module
regex.IsValidRE2(`re`)
// run a replace function (most advanced feature)
regex.Compile(`(?flags)re(capture group)`).ReplaceFunc(myByteArray, func(data func(int) []byte) []byte {
data(0) // get the string
data(1) // get the first capture group
return []byte("")
// if the last option is true, returning nil will stop the loop early
return nil
}, true /* optional: if true, will not process a return output */)
// run a replace function
regex.Compile(`re (capture)`).ReplaceString(myByteArray, []byte("test $1"))
// run a simple light replace function
regex.Compile(`re`).ReplaceStringLiteral(myByteArray, []byte("all capture groups ignored (ie: $1)"))
// return a bool if a regex matches a byte array
regex.Compile(`re`).Match(myByteArray)
// split a byte array in a similar way to JavaScript
regex.Compile(`re|(keep this and split like in JavaScript)`).Split(myByteArray)
// a regex string is modified before compiling, to add a few other features
`use \' in place of ` + "`" + ` to make things easier`
`(?#This is a comment in regex)`
// an alias of *regexp.Regexp
regex.RE2
// direct access to compiled *regexp.Regexp
regex.Compile("re").RE
// another helpful function
// this method makes it easier to return results to a regex function
regex.JoinBytes("string", []byte("byte array"), 10, 'c', data(2))
// the above method can be used in place of this one
append(append(append(append([]byte("string"), []byte("byte array")...), []byte(strconv.Itoa(10))...), 'c'), data(2)...)
```