opfs

Documentation

Overview

Package opfs is an fs implementation that supports stat, reads, and globbing.

Index

• Variables
• func NewPlanDirFS(dir string) fsPlanDir
• type FS
  • func New(root string) FS
  • func (fs FS) Abs(name string) string
  • func (fs FS) Glob(pattern string) ([]string, error)
  • func (fs FS) Join(paths ...string) string
  • func (fs FS) Open(name string) (fs.File, error)
  • func (fs FS) ReadDir(name string) ([]fs.DirEntry, error)
  • func (fs FS) ReadFile(name string) ([]byte, error)
  • func (fs FS) Stat(name string) (fs.FileInfo, error)
• type PlanDir
• type StateFileEntry
  • func (f *StateFileEntry) ChecksumOnly() *StateFileEntry
  • func (f StateFileEntry) MarshalJSON() ([]byte, error)
  • func (f *StateFileEntry) UnmarshalJSON(b []byte) error
  • func (f *StateFileEntry) WithoutTimestamps() *StateFileEntry
• type StateFileInfo
  • func (sfi StateFileInfo) IsDir() bool
  • func (sfi StateFileInfo) ModTime() time.Time
  • func (sfi StateFileInfo) Mode() fs.FileMode
  • func (sfi StateFileInfo) Name() string
  • func (sfi StateFileInfo) Size() int64
  • func (sfi StateFileInfo) Sys() interface{}

Variables

var ErrNotFound = errors.New("plandir: not found")

Functions

func NewPlanDirFS

func NewPlanDirFS(dir string) fsPlanDir

Types

type FS

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

func New

func New(root string) FS

func (FS) Abs

func (fs FS) Abs(name string) string

func (FS) Glob

func (fs FS) Glob(pattern string) ([]string, error)

func (FS) Join

func (fs FS) Join(paths ...string) string

func (FS) Open

func (fs FS) Open(name string) (fs.File, error)

func (FS) ReadDir

func (fs FS) ReadDir(name string) ([]fs.DirEntry, error)

func (FS) ReadFile

func (fs FS) ReadFile(name string) ([]byte, error)

func (FS) Stat

func (fs FS) Stat(name string) (fs.FileInfo, error)

type PlanDir

type PlanDir interface {
	fs.GlobFS
	fs.StatFS
	fs.ReadDirFS
	fs.ReadFileFS
	Join(paths ...string) string
	WithSubplan(spdir string) PlanDir
	Subplan() string
	Resolve(kind string, pats []string) ([]string, error)
}

type StateFileEntry

type StateFileEntry struct {
	Info     fs.FileInfo
	SHA256   []byte
	Contents []byte
}

func (*StateFileEntry) ChecksumOnly

func (f *StateFileEntry) ChecksumOnly() *StateFileEntry

func (StateFileEntry) MarshalJSON

func (f StateFileEntry) MarshalJSON() ([]byte, error)

func (*StateFileEntry) UnmarshalJSON

func (f *StateFileEntry) UnmarshalJSON(b []byte) error

func (*StateFileEntry) WithoutTimestamps

func (f *StateFileEntry) WithoutTimestamps() *StateFileEntry

type StateFileInfo

type StateFileInfo struct {
	RawName    string      `json:"name"`
	RawModTime time.Time   `json:"mtime,omitempty"`
	RawMode    fs.FileMode `json:"mode,omitempty"`
	RawSize    int64       `json:"size,omitempty"`
	SHA256     []byte      `json:"checksum,omitempty"`
	Contents   []byte      `json:"contents,omitempty"`
}

func (StateFileInfo) IsDir

func (sfi StateFileInfo) IsDir() bool

func (StateFileInfo) ModTime

func (sfi StateFileInfo) ModTime() time.Time

func (StateFileInfo) Mode

func (sfi StateFileInfo) Mode() fs.FileMode

func (StateFileInfo) Name

func (sfi StateFileInfo) Name() string

func (StateFileInfo) Size

func (sfi StateFileInfo) Size() int64

func (StateFileInfo) Sys

func (sfi StateFileInfo) Sys() interface{}