filesystem

package

v0.195.1 Latest Latest Go to latest Published: Sep 17, 2023 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func Inject(ctx context.Context, fs Service) context.Context

Inject will inject this filesystem Service into the context.

func ReadFile(ctx context.Context, filename string) ([]byte, error)

ReadFile will open the file from the service and read the entire contents.

func Stat(ctx context.Context, filename string) (os.FileInfo, error)

Stat will retrieve the os.FileInfo for a file.

type Dependency struct {
	FS Service
}

Dependency will inject the filesystem Service into the dependency chain.

func (d Dependency) Inject(ctx context.Context) context.Context

Inject will inject the filesystem Service into the dependency chain.

type File interface {
	io.ReadCloser
	Stat() (os.FileInfo, error)
}

File is an interface for interacting with a file.

func OpenFile(ctx context.Context, filename string) (File, error)

OpenFile will open the file from the service.

type Service interface {
	Open(fpath string) (File, error)
}

Service is the service for accessing the filesystem.

var SystemFS Service = systemFS{}

SystemFS implements the filesystem.Service by proxying all requests to the filesystem.

func Get(ctx context.Context) (Service, error)

Get will retrieve a filesystem Service from the context.Context.