fs

Documentation

Index

• func Download(destFile string, src http.File) (err error)
• func File(name string, r ContentReader) http.File
• func Files(files ...string) http.FileSystem
• func FilesWithContent(files ...string) http.FileSystem
• func HttpFile(name string, resp *http.Response) http.File
• func Plugins(fs http.FileSystem, plugins ...interface{}) http.FileSystem
• func Root() http.FileSystem
• func SequenceFile(name string, body io.ReadCloser) http.File
• func Union(fs ...http.FileSystem) http.FileSystem
• func WithTracker(fs http.FileSystem, trackerInit interface{}, exts ...string) http.FileSystem
• type ContentReader
• type HttpFS
  • func Http(urlBase string, ctx ...context.Context) *HttpFS
  • func (p *HttpFS) Open(name string) (file http.File, err error)
  • func (fs HttpFS) With(client *http.Client, header http.Header) *HttpFS
• type HttpOpener
  • func (p *HttpOpener) Open(ctx context.Context, url string) (file http.File, err error)
• type Plugin

Functions

func Download

func Download(destFile string, src http.File) (err error)

Download downloads from a http.File.

func File

func File(name string, r ContentReader) http.File

File implements a http.File by a ContentReader which may implement optional interface{ ModTime() time.Time } and io.Closer.

func Files

func Files(files ...string) http.FileSystem

Files implements a http.FileSystem by a list of file name and content file.

func FilesWithContent

func FilesWithContent(files ...string) http.FileSystem

FilesWithContent implements a http.FileSystem by a list of file name and content.

func HttpFile

func HttpFile(name string, resp *http.Response) http.File

HttpFile implements a http.File by a http.Response object.

func Plugins

func Plugins(fs http.FileSystem, plugins ...interface{}) http.FileSystem

Plugins implements a filesystem with plugins by specified (ext string, plugin Plugin) pairs.

func Root

func Root() http.FileSystem

Root implements a http.FileSystem that only have a root directory.

func SequenceFile

func SequenceFile(name string, body io.ReadCloser) http.File

SequenceFile implements a http.File by a io.ReadCloser object.

func Union

func Union(fs ...http.FileSystem) http.FileSystem

Union merge a list of http.FileSystem into a union http.FileSystem object.

func WithTracker

func WithTracker(fs http.FileSystem, trackerInit interface{}, exts ...string) http.FileSystem

WithTracker implements a http.FileSystem by pactching large file access like git lfs. Here trackerInit should be (urlBase string) or (httpfs *fs.HttpFS).

Types

type ContentReader

type ContentReader interface {
	io.Reader
	io.Seeker
	Size() int64
}

type HttpFS

type HttpFS struct {
	HttpOpener
	// contains filtered or unexported fields
}

func Http

func Http(urlBase string, ctx ...context.Context) *HttpFS

Http creates a HttpFS which implements a http.FileSystem by http.Get join(urlBase, name).

func (*HttpFS) Open

func (p *HttpFS) Open(name string) (file http.File, err error)

Open is required by http.File.

func (HttpFS) With

func (fs HttpFS) With(client *http.Client, header http.Header) *HttpFS

With specifies http.Client and http.Header used by http.Get.

type HttpOpener

type HttpOpener struct {
	Client *http.Client
	Header http.Header
}

func (*HttpOpener) Open

func (p *HttpOpener) Open(ctx context.Context, url string) (file http.File, err error)

Open opens a http.File from an url.

type Plugin

type Plugin = func(fs http.FileSystem, name string) (file http.File, err error)