fs

Documentation

Overview

Package fs defines virtual filesystem abstractions.

Index

• type Directory
• type DirectorySummary
• type Entries
  • func (e Entries) FindByName(n string) Entry
  • func (e Entries) Sort()
• type Entry
• type File
• type OwnerInfo
• type Reader
• type Symlink

Types

type Directory

type Directory interface {
	Entry
	Readdir(ctx context.Context) (Entries, error)
	Summary() *DirectorySummary
}

Directory represents contents of a directory.

type DirectorySummary

type DirectorySummary struct {
	TotalFileSize    int64     `json:"size"`
	TotalFileCount   int64     `json:"files"`
	TotalDirCount    int64     `json:"dirs"`
	MaxModTime       time.Time `json:"maxTime"`
	IncompleteReason string    `json:"incomplete,omitempty"`
}

DirectorySummary represents summary information about a directory.

type Entries

type Entries []Entry

Entries is a list of entries sorted by name.

func (Entries) FindByName

func (e Entries) FindByName(n string) Entry

FindByName returns an entry with a given name, or nil if not found.

func (Entries) Sort

func (e Entries) Sort()

Sort sorts the entries by name.

type Entry

type Entry interface {
	os.FileInfo
	Owner() OwnerInfo
}

Entry represents a filesystem entry, which can be Directory, File, or Symlink

type File

type File interface {
	Entry
	Open(ctx context.Context) (Reader, error)
}

File represents an entry that is a file.

type OwnerInfo

type OwnerInfo struct {
	UserID  uint32
	GroupID uint32
}

OwnerInfo describes owner of a filesystem entry

type Reader

type Reader interface {
	io.ReadCloser
	io.Seeker

	Entry() (Entry, error)
}

Reader allows reading from a file and retrieving its up-to-date file info.

type Symlink

type Symlink interface {
	Entry
	Readlink(ctx context.Context) (string, error)
}

Symlink represents a symbolic link entry.