README
¶
Streaming text replacement
This package provides a x/text/transform.Transformer implementation that replaces text
Example
package main
import (
"io"
"os"
"regexp"
"github.com/icholy/replace"
)
func main() {
f, _ := os.Open("file")
defer f.Close()
r := replace.Chain(f,
// simple replace
replace.String("foo", "bar"),
replace.Bytes([]byte("thing"), []byte("test")),
// remove all words that start with baz
replace.Regexp(regexp.MustCompile(`baz\w*`), nil),
// surround all words with parentheses
replace.RegexpString(regexp.MustCompile(`\w+`), "($0)"),
// increment all numbers
replace.RegexpStringFunc(regexp.MustCompile(`\d+`), func(match string) string {
x, _ := strconv.Atoi(match)
return strconv.Itoa(x+1)
}),
)
_, _ = io.Copy(os.Stdout, r)
}
Notes Regexp* functions
RegexpTransformeris stateful and cannot be used concurrently.- The
replacefunctions should not save or modify any[]byteparameters they recieve. - If a match is longer than
MaxMatchSizeit may be skipped (Default 2kb). - For better performance, reduce the
MaxMatchSizesize to the largest possible match. - Do not use with transform.Chain, see https://github.com/golang/go/issues/49117.
Documentation
¶
Index ¶
- func Chain(r io.Reader, tt ...transform.Transformer) io.Reader
- type RegexpTransformer
- func Regexp(re *regexp.Regexp, new []byte) *RegexpTransformer
- func RegexpFunc(re *regexp.Regexp, replace func([]byte) []byte) *RegexpTransformer
- func RegexpIndexFunc(re *regexp.Regexp, replace func(src []byte, index []int) []byte) *RegexpTransformer
- func RegexpString(re *regexp.Regexp, template string) *RegexpTransformer
- func RegexpStringFunc(re *regexp.Regexp, replace func(string) string) *RegexpTransformer
- func RegexpStringSubmatchFunc(re *regexp.Regexp, replace func([]string) string) *RegexpTransformer
- func RegexpSubmatchFunc(re *regexp.Regexp, replace func([][]byte) []byte) *RegexpTransformer
- type Transformer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type RegexpTransformer ¶ added in v0.2.0
type RegexpTransformer struct {
// MaxMatchSize is the maximum size of a regexp match.
// If a match exceeds this limit, it may be omitted.
// (Default is 2kb).
MaxMatchSize int
// contains filtered or unexported fields
}
RegexpTransformer replaces regexp matches in a stream See: http://golang.org/x/text/transform Note: this Transformer is not safe for concurrent use.
func Regexp ¶ added in v0.2.0
func Regexp(re *regexp.Regexp, new []byte) *RegexpTransformer
Regexp returns a transformer that replaces all matches of re with new
func RegexpFunc ¶ added in v0.2.0
func RegexpFunc(re *regexp.Regexp, replace func([]byte) []byte) *RegexpTransformer
RegexpFunc returns a transformer that replaces all matches of re with the result of calling replace with the match. The []byte parameter passed to replace should not be modified and is not guaranteed to be valid after the function returns.
func RegexpIndexFunc ¶ added in v0.2.2
func RegexpIndexFunc(re *regexp.Regexp, replace func(src []byte, index []int) []byte) *RegexpTransformer
RegexpIndexFunc returns a transformer that replaces all matches of re with the return value of replace. The replace function recieves the underlying src buffer and indexes into that buffer. The []byte parameter passed to replace should not be modified and is not guaranteed to be valid after the function returns.
func RegexpString ¶ added in v0.2.0
func RegexpString(re *regexp.Regexp, template string) *RegexpTransformer
RegexpString returns a transformer that replaces all matches of re with template Inside template, $ signs are interpreted as in Expand, so for instance $1 represents the text of the first submatch.
func RegexpStringFunc ¶ added in v0.2.0
func RegexpStringFunc(re *regexp.Regexp, replace func(string) string) *RegexpTransformer
RegexpStringFunc returns a transformer that replaces all matches of re with the result of calling replace with the match.
func RegexpStringSubmatchFunc ¶ added in v0.2.0
func RegexpStringSubmatchFunc(re *regexp.Regexp, replace func([]string) string) *RegexpTransformer
RegexpStringSubmatchFunc returns a transformer that replaces all matches of re with the result of calling replace with the submatch.
func RegexpSubmatchFunc ¶ added in v0.2.0
func RegexpSubmatchFunc(re *regexp.Regexp, replace func([][]byte) []byte) *RegexpTransformer
RegexpSubmatchFunc returns a transformer that replaces all matches of re with the result of calling replace with the submatch. The [][]byte parameter passed to replace should not be modified and is not guaranteed to be valid after the function returns.
func (*RegexpTransformer) Reset ¶ added in v0.3.1
func (t *RegexpTransformer) Reset()
Reset resets the state and allows a Transformer to be reused.
type Transformer ¶
type Transformer struct {
transform.NopResetter
// contains filtered or unexported fields
}
Transformer replaces text in a stream See: http://golang.org/x/text/transform
func Bytes ¶
func Bytes(old, new []byte) Transformer
Bytes returns a transformer that replaces all instances of old with new. Unlike bytes.Replace, empty old values don't match anything.
func String ¶
func String(old, new string) Transformer
String returns a transformer that replaces all instances of old with new. Unlike strings.Replace, empty old values don't match anything.
Source Files
Directories