fsx

package

v1.0.0 Latest Latest Go to latest Published: Feb 24, 2025 License: Apache-2.0 Imports: 2 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type BaseFS struct {
	afero.Fs
}

BaseFS is our default implementation of the FS interface.

func FromAfero(fSys afero.Fs) *BaseFS

FromAfero returns a new BaseFS instance from an afero.Fs.

func FromIOFS(fSys fs.FS) *BaseFS

FromIOFS returns a new BaseFS instance from an io/fs.FS.

func NewBasePathFs(fSys FS, basePath string) *BaseFS

NewBasePathFs returns a new BaseFS which wraps the given filesystem with a base path.

func NewMemMapFs() *BaseFS

NewMemMapFs returns a new BaseFS which wraps the memory filesystem.

func NewOsFs() *BaseFS

NewOsFs returns a new BaseFS which wraps the OS filesystem.

func NewReadOnlyFs(FfSys FS) *BaseFS

NewReadOnlyFs returns a new BaseFS which wraps the given filesystem with a read-only filesystem.

func (b *BaseFS) IOFS() fs.FS

IOFS returns the filesystem as an io/fs.FS.

type FS interface {
	afero.Fs
	IOFS() fs.FS
}

FS is our default interface for filesystems.

type FallbackFS struct {
	FS
	// contains filtered or unexported fields
}

FallbackFS is a filesystem that layers a primary filesystem on top of a secondary filesystem.

func NewFallbackFS(primary, secondary FS) *FallbackFS

NewFallbackFS returns a new FallbackFS instance.

func (d *FallbackFS) Primary() *BaseFS

Primary returns the primary filesystem.

func (d *FallbackFS) Secondary() *BaseFS

Secondary returns the secondary filesystem.