vio

README

Go Virtual I/O Package

This package provides function types for common file operation functions, like os.ReadFile() and os.Stat(). Because these are types, they can be implemented like higher-order functions in your application.

The reason for writing this package, is so that I can make my application code more testable.

Badges

Documentation

Index

• type DirFunc
• type ReadFunc
• type RemoveFunc
• type StatFunc
• type VirtualFileInfo
  • func MakeVirtualFileInfo(n string, si int64, m fs.FileMode, mt time.Time, i bool, sy any) VirtualFileInfo
  • func (vfi VirtualFileInfo) IsDir() bool
  • func (vfi VirtualFileInfo) ModTime() time.Time
  • func (vfi VirtualFileInfo) Mode() fs.FileMode
  • func (vfi VirtualFileInfo) Name() string
  • func (vfi VirtualFileInfo) Size() int64
  • func (vfi VirtualFileInfo) Sys() any
• type WriteFunc

Types

type DirFunc

type DirFunc func(string, fs.FileMode) error

Virtual function for os.Mkdir/os.MkdirAll

type ReadFunc

type ReadFunc func(string) ([]byte, error)

Virtual function for os.ReadFile

type RemoveFunc

type RemoveFunc func(string) error

Virtual function for os.Remove/os.RemoveAll

type StatFunc

type StatFunc func(string) (fs.FileInfo, error)

Virtual function for os.Stat

type VirtualFileInfo

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

Virtual file information object

func MakeVirtualFileInfo

func MakeVirtualFileInfo(n string, si int64, m fs.FileMode, mt time.Time, i bool, sy any) VirtualFileInfo

Allocation function for VirtualFileInfo

func (VirtualFileInfo) IsDir

func (vfi VirtualFileInfo) IsDir() bool

func (VirtualFileInfo) ModTime

func (vfi VirtualFileInfo) ModTime() time.Time

func (VirtualFileInfo) Mode

func (vfi VirtualFileInfo) Mode() fs.FileMode

func (VirtualFileInfo) Name

func (vfi VirtualFileInfo) Name() string

Implementation of os.FileInfo interface

func (VirtualFileInfo) Size

func (vfi VirtualFileInfo) Size() int64

func (VirtualFileInfo) Sys

func (vfi VirtualFileInfo) Sys() any

type WriteFunc

type WriteFunc func(string, []byte, fs.FileMode) error

Virtual function for os.WriteFile