os

Documentation

Index

• 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 ReadBase64File(path string) (string, error)
• func ReadFile(path string) (string, error)
• func SetVariable(key, value 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

Variables

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 ReadBase64File

func ReadBase64File(path string) (string, error)

ReadBase64File for the path provided.

func ReadFile

func ReadFile(path string) (string, error)

ReadFile for the path provided.

func SetVariable

func SetVariable(key, value string) error

SetVariable of value 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

func (*SystemFS) PathExists

func (*SystemFS) PathExists(name string) bool

func (*SystemFS) ReadFile

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

func (*SystemFS) WriteFile

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