glob/readme.md

115 lines
3.4 KiB
Markdown
Raw Normal View History

2015-11-30 18:24:20 +03:00
# glob.[go](https://golang.org)
2015-11-30 18:41:06 +03:00
[![GoDoc][godoc-image]][godoc-url] [![Build Status][travis-image]][travis-url]
2015-11-30 18:35:07 +03:00
2016-01-18 13:38:19 +03:00
> Go Globbing Library.
2015-11-30 18:24:20 +03:00
## Install
```shell
go get github.com/gobwas/glob
```
## Example
```go
package main
import "github.com/gobwas/glob"
func main() {
var g glob.Glob
// create simple glob
2016-01-18 13:38:19 +03:00
g = glob.MustCompile("*.github.com")
2015-11-30 18:24:20 +03:00
g.Match("api.github.com") // true
// create new glob with set of delimiters as ["."]
2016-01-18 13:38:19 +03:00
g = glob.MustCompile("api.*.com", ".")
2015-11-30 18:24:20 +03:00
g.Match("api.github.com") // true
g.Match("api.gi.hub.com") // false
// create new glob with set of delimiters as ["."]
// but now with super wildcard
2016-01-18 13:38:19 +03:00
g = glob.MustCompile("api.**.com", ".")
2015-11-30 18:24:20 +03:00
g.Match("api.github.com") // true
g.Match("api.gi.hub.com") // true
// create glob with single symbol wildcard
2016-01-18 13:38:19 +03:00
g = glob.MustCompile("?at")
2015-11-30 18:24:20 +03:00
g.Match("cat") // true
g.Match("fat") // true
g.Match("at") // false
// create glob with single symbol wildcard and delimiters ["f"]
2016-01-18 13:38:19 +03:00
g = glob.MustCompile("?at", "f")
2015-11-30 18:24:20 +03:00
g.Match("cat") // true
g.Match("fat") // false
g.Match("at") // false
2016-01-18 13:38:19 +03:00
// create glob with character-list matchers
g = glob.MustCompile("[abc]at")
g.Match("cat") // true
g.Match("bat") // true
g.Match("fat") // false
g.Match("at") // false
// create glob with character-list matchers
g = glob.MustCompile("[!abc]at")
g.Match("cat") // false
g.Match("bat") // false
g.Match("fat") // true
g.Match("at") // false
// create glob with character-range matchers
g = glob.MustCompile("[a-c]at")
g.Match("cat") // true
g.Match("bat") // true
g.Match("fat") // false
g.Match("at") // false
// create glob with character-range matchers
g = glob.MustCompile("[!a-c]at")
g.Match("cat") // false
g.Match("bat") // false
g.Match("fat") // true
g.Match("at") // false
// create glob with pattern-alternatives list
g = glob.MustCompile("{cat,bat,[fr]at}")
g.Match("cat") // true
g.Match("bat") // true
g.Match("fat") // true
g.Match("rat") // true
g.Match("at") // false
g.Match("zat") // false
2015-11-30 18:24:20 +03:00
}
2015-11-30 18:30:08 +03:00
```
## Performance
2016-01-18 13:38:19 +03:00
This library is created for compile-once patterns. This means, that compilation could take time, but
strings matching is done faster, than in case when always parsing template.
2015-11-30 18:30:08 +03:00
2016-01-18 13:38:19 +03:00
If you will not use compiled `glob.Glob` object, and do `g := glob.MustCompile(pattern); g.Match(...)` every time, then your code will be much more slower.
2015-11-30 18:41:06 +03:00
2016-01-18 13:38:19 +03:00
Run `go test -bench=.` from source root to see the benchmarks:
2015-12-01 17:22:17 +03:00
2016-01-18 13:38:19 +03:00
Pattern | Fixture | Operations | Speed (ns/op)
--------|---------|------------|--------------
2016-01-18 13:39:18 +03:00
`[a-z][!a-x]*cat*[h][!b]*eyes*` | - (parsing) | 50000 | 26497
2016-01-18 13:38:19 +03:00
`[a-z][!a-x]*cat*[h][!b]*eyes*` | `my cat has very bright eyes` | 2000000 | 615
`https://*.google.*` | `https://account.google.com` | 10000000 | 121
`{https://*.google.*,*yandex.*,*yahoo.*,*mail.ru}` | `http://yahoo.com` | 10000000 | 167
`{https://*gobwas.com,http://exclude.gobwas.com}` | `https://safe.gobwas.com` | 50000000 | 24.7
`abc*` | `abcdef` | 200000000 | 9.49
`*def` | `abcdef` | 200000000 | 9.60 ns/op
`ab*ef` | `abcdef` | 100000000 | 15.2
2015-11-30 18:41:06 +03:00
[godoc-image]: https://godoc.org/github.com/gobwas/glob?status.svg
[godoc-url]: https://godoc.org/github.com/gobwas/glob
[travis-image]: https://travis-ci.org/gobwas/glob.svg?branch=master
[travis-url]: https://travis-ci.org/gobwas/glob