Filesystem abstraction layer for Golang, that works with Local filesystem and Amazon S3 with a unified API. You can even copy-paste files from different sources. FTP, Dropbox etc. will follow soon.
import "github.com/usmanhalalit/gost/s3"
// Initialize a filesystem
fs, err := s3.New(s3.Config{ your-aws-credentials })
// Read
note, err := fs.File("my-note.txt").ReadString()
//Write
err := fs.File("another-note.txt").WriteString("another note")
// Traverse naturally
movies := fs.Directory("movies")
files := movies.Files()
movies.File("Pirated-movie.mp4").Delete()
// Copy file from one source to another
localFile := lfs.File("photo.jpg")
s3Dir := fs.Directory("photos")
err := localFile.CopyTo(s3dir)Get the library:
go get github.com/usmanhalalit/gost
You just initialize the S3 and Local adapters differently, everything else in the API is same.
import "github.com/usmanhalalit/gost/s3"
fs, err := s3.New(s3.Config{
ID: "aws-id",
Key: "aws-key",
Region: "es-west-1",
Bucket: "your-bucket",
})
import "github.com/usmanhalalit/gost/local"
fs, err := local.New(local.Config{
BasePath: "/home/user",
})Simple read, suitable for small files.
fileContent, err := fs.File("test.txt").ReadString()Bytes read, compatible with io.Reader, so you can do buffered read.
b := make([]byte, 3)
n, err := fs.File("test.txt").Read(b)Simple write
fs.File("test.txt").WriteString("sample content")Bytes write
n, err := file.Write(bytes)
// n == number of bytes writtenYou can explore the filesystem like you in your desktop file explorer. File and directories are chained in a natural way.
dirs, err := fs.Directory("Parent").Directory("Child").Directories()
files, err := fs.Directory("Parent").Directory("Child").Files()dirs, err := fs.Directory("Parent").Directory("Child").Files()Get all files and loop through them
files, err := fs.Files()
for _, file := range files {
fmt.Println(file.ReadString())
}Get all directories and loop through them
dirs, err := fs.Directories()
for _, dir := range dirs {
files := dir.Files()
fmt.Println(files)
}Get the directory which contains a file
dir := fs.File("test.txt").Directory()Get file size and last modified timestamp:
stat, _ := fs.File("test.txt").Stat()
fmt.Println(stat.Size)
fmt.Println(stat.LastModified)You can get stat of directories too, but it's not available on S3.
fs.Directory("Downloads").File("test.txt").GetPath()Delete a file and directory:
fs.File("test.txt").Delete()
// Delete an entire directory, beware please!
fs.Directory("Images").Delete()Create a new directory:
fs.Directory("Images").Create()To create a new file simply write something to it:
fs.File("non_existent_file").WriteString("")You can copy a file to any Directory, be it in in the same filesystem or not(local or S3)
localFile := lfs.File("photo.jpg")
s3Dir := s3fs.Directory("photos")
err := localFile.CopyTo(s3dir)Fun, eh?
You can optionally provide a new filename too:
err := localFile.CopyTo(anotherDir, "copied_file.jpg")Also there is a helper to copy file in the same Directory:
file.Copy("copied_file.jpg")Yes, you can write one and it'll be appreciated if you contribute back.
. gost.go file has all the interfaces defined. Basically you've to implement
gost.File and gost.Directory interfaces. Check the local adapter to get an idea.
Please follow the Go Doc: https://godoc.org/github.com/usmanhalalit/gost
Also check the _test files here to get more idea about the usage.
You can follow me on Twitter 🙂
© Muhammad Usman. Licensed under MIT license.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent