Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dixonwille/skywalker
A package to allow one to concurrently go through a filesystem with ease
https://github.com/dixonwille/skywalker
awesome-go concurrency filesystem golang golang-package
Last synced: about 1 month ago
JSON representation
A package to allow one to concurrently go through a filesystem with ease
- Host: GitHub
- URL: https://github.com/dixonwille/skywalker
- Owner: dixonwille
- License: bsd-3-clause
- Created: 2017-08-01T20:08:25.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2021-08-31T17:22:09.000Z (over 3 years ago)
- Last Synced: 2024-11-01T07:33:22.445Z (about 2 months ago)
- Topics: awesome-go, concurrency, filesystem, golang, golang-package
- Language: Go
- Homepage:
- Size: 20.5 KB
- Stars: 101
- Watchers: 7
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-go - skywalker - Package to allow one to concurrently go through a filesystem with ease. (File Handling / Search and Analytic Databases)
- awesome-go - skywalker - A package to allow one to concurrently go through a filesystem with ease - ★ 38 (Files)
- awesome-go-extra - skywalker - 08-01T20:08:25Z|2021-08-31T17:22:09Z| (File Handling / Advanced Console UIs)
README
# skywalker [](https://godoc.org/github.com/dixonwille/skywalker) [](https://travis-ci.org/dixonwille/skywalker) [](https://ci.appveyor.com/project/dixonwille/skywalker) [](https://codecov.io/gh/dixonwille/skywalker) [](https://goreportcard.com/report/github.com/dixonwille/skywalker)
Skywalker is a package to allow one to concurrently go through a filesystem with ease.
## Features
- Concurrency
- BlackList filtering
- WhiteList filtering
- Filter by Directory
- Filter by Extension
- Glob Filtering (provided by [gobwas/glob](https://github.com/gobwas/glob))
> For matching to work properly across platforms. Please use `/`. In [gobwas/glob](https://github.com/gobwas/glob) the `\` is an escape character (so you can escape `*`, `?`, etc...) making it difficult to know if you want to escape a character or go into directory.
## Example
```go
package main
import (
"fmt"
"sort"
"strings"
"sync"
"github.com/dixonwille/skywalker"
)
type ExampleWorker struct {
*sync.Mutex
found []string
}
func (ew *ExampleWorker) Work(path string) {
//This is where the necessary work should be done.
//This will get concurrently so make sure it is thread safe if you need info across threads.
ew.Lock()
defer ew.Unlock()
ew.found = append(ew.found, path)
}
func main() {
//Following two functions are only to create and destroy data for the example
defer teardownData()
standupData()
ew := new(ExampleWorker)
ew.Mutex = new(sync.Mutex)
//root is the root directory of the data that was stood up above
sw := skywalker.New(root, ew)
sw.DirListType = skywalker.LTBlacklist
sw.DirList = []string{"sub"}
sw.ExtListType = skywalker.LTWhitelist
sw.ExtList = []string{".pdf"}
err := sw.Walk()
if err != nil {
fmt.Println(err)
return
}
sort.Sort(sort.StringSlice(ew.found))
for _, f := range ew.found {
fmt.Println(strings.Replace(f, sw.Root, "", 1))
}
}
```