system

Documentation

Index

• func NewErrFileSystem(err error, path, msg string) error
• type ErrFileSystem
  • func (e ErrFileSystem) Error() string
  • func (e ErrFileSystem) Is(target error) bool
• type Option
  • func WithConfigCome(configHome string) Option
  • func WithFS(fs afero.Fs) Option
  • func WithUserConfigDirs(configDirs []string) Option
  • func WithUserContainersDir(userContainersDir string) Option
  • func WithUserDataDir(userDataDir string) Option
  • func WithUserHome(userHome string) Option
• type System
  • func NewSystem(options ...Option) *System
  • func (s *System) ConfigPath() string
  • func (s *System) CreatePath(path string)
  • func (s *System) DirExists(path string) bool
  • func (s *System) FileExists(path string) bool
  • func (s *System) HomeDir() string
  • func (s *System) HomeEnvValue() string
  • func (s *System) IsEmpty(path string) bool
  • func (s *System) ReadFile(path string) []byte
  • func (s *System) Remove(path string)
  • func (s *System) RemoveAll(path string)
  • func (s *System) ThemesDir() string
  • func (s *System) UserConfigDirs() []string
  • func (s *System) UserContainerPreferences(appID string) (string, error)
  • func (s *System) UserContainersHome() string
  • func (s *System) UserDataHome() string
  • func (s *System) UserHome() string
  • func (s *System) WriteFile(path string, data []byte)

Functions

func NewErrFileSystem

func NewErrFileSystem(err error, path, msg string) error

Types

type ErrFileSystem

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

func (ErrFileSystem) Error

func (e ErrFileSystem) Error() string

func (ErrFileSystem) Is

func (e ErrFileSystem) Is(target error) bool

type Option

type Option interface {
	// contains filtered or unexported methods
}

Option configures a Provider.

func WithConfigCome

func WithConfigCome(configHome string) Option

WithConfigCome sets the primary config home directory of the user.

func WithFS

func WithFS(fs afero.Fs) Option

WithFS sets the file system.

func WithUserConfigDirs

func WithUserConfigDirs(configDirs []string) Option

WithUserConfigDirs sets the config directories of the user.

func WithUserContainersDir

func WithUserContainersDir(userContainersDir string) Option

WithUserContainersDir sets the data directory of the user.

func WithUserDataDir

func WithUserDataDir(userDataDir string) Option

WithUserDataDir sets the data directory of the user.

func WithUserHome

func WithUserHome(userHome string) Option

WithUserHome sets the home directory of the user.

type System

type System struct {
	Fs afero.Fs
	// contains filtered or unexported fields
}

func NewSystem

func NewSystem(options ...Option) *System

func (*System) ConfigPath

func (s *System) ConfigPath() string

func (*System) CreatePath

func (s *System) CreatePath(path string)

CreatePath returns a suitable location relative to which the file pointed by `path` can be written.

func (*System) DirExists

func (s *System) DirExists(path string) bool

func (*System) FileExists

func (s *System) FileExists(path string) bool

func (*System) HomeDir

func (s *System) HomeDir() string

func (*System) HomeEnvValue

func (s *System) HomeEnvValue() string

func (*System) IsEmpty

func (s *System) IsEmpty(path string) bool

func (*System) ReadFile

func (s *System) ReadFile(path string) []byte

func (*System) Remove

func (s *System) Remove(path string)

func (*System) RemoveAll

func (s *System) RemoveAll(path string)

func (*System) ThemesDir

func (s *System) ThemesDir() string

func (*System) UserConfigDirs

func (s *System) UserConfigDirs() []string

func (*System) UserContainerPreferences

func (s *System) UserContainerPreferences(appID string) (string, error)

func (*System) UserContainersHome

func (s *System) UserContainersHome() string

func (*System) UserDataHome

func (s *System) UserDataHome() string

func (*System) UserHome

func (s *System) UserHome() string

func (*System) WriteFile

func (s *System) WriteFile(path string, data []byte)