writefs

package

v1.0.1 Latest Latest Go to latest Published: May 17, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ocfl-archive/filesystem

Links

Open Source Insights

README ¶

writefs

writefs is an extension of the Go standard library's io/fs package that provides write access to file systems.

Key Features

Write Interfaces: Extends io/fs with interfaces for creating, appending, and managing files and directories.
FullFS Interface: A comprehensive interface that combines standard io/fs read operations with write operations like Create, Append, MkDir, Rename, Remove, Copy, and WriteFile.
Interoperability: Works alongside standard Go io/fs.FS implementations while providing additional capabilities when needed.

Core Interfaces

The package defines several small, focused interfaces for write operations:

CreateFS: Provides a Create(path string) (FileWrite, error) method.
AppendFS: Provides an Append(path string) (FileWrite, error) method.
MkDirFS: Provides a MkDir(path string) error method.
RenameFS: Provides a Rename(oldPath, newPath string) error method.
RemoveFS: Provides a Remove(path string) error method.
WriteFileFS: Provides a WriteFile(name string, data []byte) (int64, error) method.
CopyFS: Provides a Copy(src, dst string) (int64, error) method.
FullpathFS: Provides a Fullpath(name string) (string, error) method for obtaining the full path of a file.

`FullFS`

FullFS is the most common interface used by this library. It embeds all of the above write-related interfaces plus standard io/fs interfaces:

type FullFS interface {
	CopyFS
	CreateFS
	AppendFS
	MkDirFS
	RenameFS
	RemoveFS
	CloseFS
	WriteFileFS
	FullpathFS
	EqualFS
	fs.FS
	fs.ReadDirFS
	fs.ReadFileFS
	fs.StatFS
}

Usage

When implementing a new filesystem that supports writing, it should implement the FullFS interface or at least the relevant sub-interfaces. Other parts of the library, such as vfsrw, use these interfaces to provide a unified way to interact with different storage backends.

Documentation ¶

Index ¶

Constants
Variables
func Close(fsys fs.FS) error
func Copy(srcFS fs.FS, src string, dstFS fs.FS, dst string) (int64, error)
func Equal(fsys1, fsys2 fs.FS) bool
func Fullpath(fsys fs.FS, name string) (string, error)
func HasContent(fsys fs.FS) bool
func IsEmpty(fsys fs.FS, dir string) (bool, error)
func IsWriteable(fsys fs.FS, path string) bool
func Join(fsys fs.FS, elems ...string) string
func MkDir(fsys fs.FS, path string) error
func NewDirEntry(info fs.FileInfo) *dirEntry
func NewFileInfoDir(base string) *fileInfoDir
func NewNopReadCloser(r io.Reader) io.ReadCloser
func NewNopWriteCloser(w io.Writer) io.WriteCloser
func NewSidecarAESWriter(w io.Writer, aesWriter io.WriteCloser) (io.WriteCloser, error)
func NewSidecarChecksumWriter(w io.Writer, sidecars map[checksum.DigestAlgorithm]io.WriteCloser) (io.WriteCloser, error)
func NewSubFS(fsys fs.FS, dir string) (fs.FS, error)
func RealPath(fSys fs.FS, dir string) string
func Remove(fsys fs.FS, path string) error
func Rename(fsys fs.FS, oldPath, newPath string) error
func Sub(fsys fs.FS, dir string) (fs.FS, error)
func SubCreate(fSys fs.FS, dir string) (fs.FS, error)
func WriteFile(fsys fs.FS, name string, data []byte) (int64, error)
type AppendFS
type CloseFS
type CopyFS
type CreateFS
type CreateFSFunc
type EqualFS
type Factory
- func NewFactory() (*Factory, error)
- func (f *Factory) Get(path string, readOnly bool) (fs.FS, error)
- func (f *Factory) Register(create CreateFSFunc, identifyRegex string, level levelFS) error
type FileWrite
- func Append(fsys fs.FS, path string) (FileWrite, error)
- func Create(fsys fs.FS, path string) (FileWrite, error)
type FileWriteSeeker
type FileWriterAt
type FullFS
type FullpathFS
type IFactory
type IsEmptyFS
type IsLockedFS
type IsWriteableFS
type JoinFS
type MkDirFS
type Mutex
- func NewMutex() *Mutex
- func (m *Mutex) IsLocked() bool
- func (m *Mutex) Lock()
- func (m *Mutex) Unlock()
type ReadWriteFS
type RealPathFS
type RemoveFS
type RenameFS
type SubCreateFS
type SubFS
type WriteFileFS

Constants ¶

View Source

const (
	LowFS levelFS = iota
	MediumFS
	HighFS
)

Variables ¶

View Source

var ErrNotImplemented = errors.NewPlain("not implemented")

Functions ¶

func Close ¶

func Close(fsys fs.FS) error

func Copy ¶

func Copy(srcFS fs.FS, src string, dstFS fs.FS, dst string) (int64, error)

func Equal ¶

func Equal(fsys1, fsys2 fs.FS) bool

func Fullpath ¶

func Fullpath(fsys fs.FS, name string) (string, error)

func HasContent ¶

func HasContent(fsys fs.FS) bool

func IsEmpty ¶

func IsEmpty(fsys fs.FS, dir string) (bool, error)

func IsWriteable ¶

func IsWriteable(fsys fs.FS, path string) bool

func Join ¶

func Join(fsys fs.FS, elems ...string) string

func MkDir ¶

func MkDir(fsys fs.FS, path string) error

func NewDirEntry ¶

func NewDirEntry(info fs.FileInfo) *dirEntry

NewDirEntry creates a new DirEntry from a FileInfo.

func NewFileInfoDir ¶

func NewFileInfoDir(base string) *fileInfoDir

NewFileInfoDir creates a new FileInfo for a directory.

func NewNopReadCloser ¶

func NewNopReadCloser(r io.Reader) io.ReadCloser

NopReadCloser returns a ReadCloser with a no-op Close method wrapping

func NewNopWriteCloser ¶

func NewNopWriteCloser(w io.Writer) io.WriteCloser

func NewSidecarAESWriter ¶

func NewSidecarAESWriter(w io.Writer, aesWriter io.WriteCloser) (io.WriteCloser, error)

func NewSidecarChecksumWriter ¶

func NewSidecarChecksumWriter(w io.Writer, sidecars map[checksum.DigestAlgorithm]io.WriteCloser) (io.WriteCloser, error)

func NewSubFS ¶

func NewSubFS(fsys fs.FS, dir string) (fs.FS, error)

func RealPath ¶

func RealPath(fSys fs.FS, dir string) string

func Remove ¶

func Remove(fsys fs.FS, path string) error

func Rename ¶

func Rename(fsys fs.FS, oldPath, newPath string) error

func Sub ¶

func Sub(fsys fs.FS, dir string) (fs.FS, error)

func SubCreate ¶

func SubCreate(fSys fs.FS, dir string) (fs.FS, error)

func WriteFile ¶

func WriteFile(fsys fs.FS, name string, data []byte) (int64, error)

Types ¶

type AppendFS ¶

type AppendFS interface {
	Append(path string) (FileWrite, error)
}

type CloseFS ¶

type CloseFS interface {
	Close() error
}

type CopyFS ¶

type CopyFS interface {
	Copy(src, dst string) (int64, error)
}

type CreateFS ¶

type CreateFS interface {
	Create(path string) (FileWrite, error)
}

type CreateFSFunc ¶

type CreateFSFunc func(f IFactory, path string, readOnly bool) (fs.FS, error)

type EqualFS ¶

type EqualFS interface {
	Equal(fsys fs.FS) bool
}

type Factory ¶

type Factory struct {
	// contains filtered or unexported fields
}

func NewFactory ¶

func NewFactory() (*Factory, error)

func (*Factory) Get ¶

func (f *Factory) Get(path string, readOnly bool) (fs.FS, error)

func (*Factory) Register ¶

func (f *Factory) Register(create CreateFSFunc, identifyRegex string, level levelFS) error

type FileWrite ¶

type FileWrite interface {
	io.WriteCloser
}

func Append ¶

func Append(fsys fs.FS, path string) (FileWrite, error)

func Create ¶

func Create(fsys fs.FS, path string) (FileWrite, error)

type FileWriteSeeker ¶

type FileWriteSeeker interface {
	FileWrite
	io.Seeker
}

type FileWriterAt ¶

type FileWriterAt interface {
	FileWrite
	io.WriterAt
}

type FullFS ¶

type FullFS interface {
	CopyFS
	CreateFS
	AppendFS
	MkDirFS
	RenameFS
	RemoveFS
	CloseFS
	WriteFileFS
	FullpathFS
	EqualFS
	SubFS
	SubCreateFS
	RealPathFS
	IsEmptyFS
	fs.FS
	fs.ReadDirFS
	fs.ReadFileFS
	fs.StatFS
}

type FullpathFS ¶

type FullpathFS interface {
	Fullpath(name string) (string, error)
}

type IFactory ¶

type IFactory interface {
	Get(path string, readOnly bool) (fs.FS, error)
}

type IsEmptyFS ¶

type IsEmptyFS interface {
	IsEmpty(dir string) (bool, error)
}

type IsLockedFS ¶

type IsLockedFS interface {
	fs.FS
	IsLocked() bool
}

IsLockedFS is a fs.FS that can be checked for being locked.

type IsWriteableFS ¶

type IsWriteableFS interface {
	IsWriteable(path string) bool
}

type JoinFS ¶

type JoinFS interface {
	Join(fsys fs.FS, elems ...string) string
}

type MkDirFS ¶

type MkDirFS interface {
	MkDir(path string) error
}

type Mutex ¶

type Mutex struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewMutex ¶

func NewMutex() *Mutex

func (*Mutex) IsLocked ¶

func (m *Mutex) IsLocked() bool

func (*Mutex) Lock ¶

func (m *Mutex) Lock()

func (*Mutex) Unlock ¶

func (m *Mutex) Unlock()

type ReadWriteFS ¶

type ReadWriteFS interface {
	fs.FS
	CreateFS
}

type RealPathFS ¶

type RealPathFS interface {
	RealPath(path string) string
}

type RemoveFS ¶

type RemoveFS interface {
	Remove(path string) error
}

type RenameFS ¶

type RenameFS interface {
	Rename(oldPath, newPath string) error
}

type SubCreateFS ¶

type SubCreateFS interface {
	SubCreate(dir string) (fs.FS, error)
}

type SubFS ¶

type SubFS interface {
	Sub(dir string) (fs.FS, error)
}

type WriteFileFS ¶

type WriteFileFS interface {
	WriteFile(name string, data []byte) (int64, error)
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL