os

Documentation

Index

• Constants
• Variables
• func ExecutableName() string
• func GetVariable(key string) string
• func IsNotExist(err error) bool
• func PathExists(path string) bool
• func PathExtension(path string) string
• func ReadFile(path string) (string, error)
• func Remove(name string) error
• func SetVariable(key, value string) error
• func UnsetVariable(key string) error
• func WriteFile(name string, data string, perm FileMode) error
• type FileMode
• type FileSystem
  • func NewFS() FileSystem
• type SystemFS
  • func (*SystemFS) IsNotExist(err error) bool
  • func (*SystemFS) PathExists(name string) bool
  • func (*SystemFS) ReadFile(path string) (string, error)
  • func (*SystemFS) WriteFile(name string, data string, perm FileMode) error

Constants

const ModeAppend = os.ModeAppend

ModeAppend will append to an existing file.

Variables

var Args = os.Args

Args is an alias for os.Args.

var Exit = os.Exit

Exit is just an alias to os.Exit.

var Module = fx.Options(
	fx.Provide(NewFS),
)

Module for fx.

Functions

func ExecutableName

func ExecutableName() string

ExecutableName of the running application.

func GetVariable

func GetVariable(key string) string

GetVariable by key.

func IsNotExist

func IsNotExist(err error) bool

IsNotExist if the error is os.ErrNotExist.

func PathExists

func PathExists(path string) bool

PathExists for the path provided.

func PathExtension

func PathExtension(path string) string

PathExtension of the specified path.

func ReadFile

func ReadFile(path string) (string, error)

ReadFile for the path provided.

func Remove

func Remove(name string) error

Remove a file or empty folder.

func SetVariable

func SetVariable(key, value string) error

SetVariable of value by key.

func UnsetVariable

func UnsetVariable(key string) error

UnsetVariable by key.

func WriteFile

func WriteFile(name string, data string, perm FileMode) error

WriteFile writes data to name with perm.

Types

type FileMode

type FileMode = os.FileMode

FileMode is an alias to os.FileMode.

type FileSystem

type FileSystem interface {
	// ReadFile for the path provided.
	ReadFile(path string) (string, error)

	// WriteFile writes data to name.
	WriteFile(name string, data string, perm FileMode) error

	// PathExists for the path provided.
	PathExists(path string) bool

	// IsNotExist whether the error is os.ErrNotExist.
	IsNotExist(err error) bool
}

FileSystem borrows concepts from io/fs.

func NewFS

func NewFS() FileSystem

NewFS for os.

type SystemFS

type SystemFS struct{}

SystemFS uses the underlying os.

func (*SystemFS) IsNotExist

func (*SystemFS) IsNotExist(err error) bool

IsNotExist for os.

func (*SystemFS) PathExists

func (*SystemFS) PathExists(name string) bool

PathExists for os.

func (*SystemFS) ReadFile

func (*SystemFS) ReadFile(path string) (string, error)

ReadFile for os.

func (*SystemFS) WriteFile

func (*SystemFS) WriteFile(name string, data string, perm FileMode) error

WriteFile for os.