utils

Documentation

Index

• func AddContentOrCreateFile(logger log.Logger, osProxy OsProxy, filePath string, blockSuffix string, ...) error
• func AllEnvs() map[string]string
• func ReadFileIfExists(pth string) (string, bool, error)
• type Command
• type CommandFunc
  • func DefaultCommandFunc() CommandFunc
• type CommandWrapper
  • func (cmd CommandWrapper) CombinedOutput() ([]byte, error)
  • func (cmd CommandWrapper) Err() error
  • func (cmd CommandWrapper) PID() int
  • func (cmd CommandWrapper) SetStderr(file *os.File)
  • func (cmd CommandWrapper) SetStdin(file *os.File)
  • func (cmd CommandWrapper) SetStdout(file *os.File)
  • func (cmd CommandWrapper) SetSysProcAttr(sysProcAttr *syscall.SysProcAttr)
  • func (cmd CommandWrapper) Start() error
  • func (cmd CommandWrapper) Wait() error
• type Decoder
• type DecoderFactory
• type DefaultDecoderFactory
  • func (factory DefaultDecoderFactory) Decoder(r io.Reader) Decoder
• type DefaultEncoderFactory
  • func (factory DefaultEncoderFactory) Encoder(w io.Writer) Encoder
• type DefaultOsProxy
  • func (d DefaultOsProxy) Create(name string) (*os.File, error)
  • func (d DefaultOsProxy) Executable() (string, error)
  • func (d DefaultOsProxy) FindProcess(pid int) (*os.Process, error)
  • func (d DefaultOsProxy) Getwd() (string, error)
  • func (d DefaultOsProxy) Hostname() (string, error)
  • func (d DefaultOsProxy) MkdirAll(pth string, perm os.FileMode) error
  • func (d DefaultOsProxy) OpenFile(name string, flag int, perm os.FileMode) (*os.File, error)
  • func (d DefaultOsProxy) ReadFileIfExists(pth string) (string, bool, error)
  • func (d DefaultOsProxy) Remove(name string) error
  • func (d DefaultOsProxy) Stat(name string) (os.FileInfo, error)
  • func (d DefaultOsProxy) TempDir() string
  • func (d DefaultOsProxy) UserHomeDir() (string, error)
  • func (d DefaultOsProxy) WriteFile(name string, data []byte, perm os.FileMode) error
• type Encoder
• type EncoderFactory
• type OsProxy
• type TemplateProxy
  • func DefaultTemplateProxy() TemplateProxy

Functions

func AddContentOrCreateFile

func AddContentOrCreateFile(
	logger log.Logger,
	osProxy OsProxy,
	filePath string,
	blockSuffix string,
	content string,
) error

func AllEnvs

func AllEnvs() map[string]string

func ReadFileIfExists

func ReadFileIfExists(pth string) (string, bool, error)

Types

type Command

type Command interface {
	Start() error
	Wait() error
	Err() error
	CombinedOutput() ([]byte, error)
	SetStdout(file *os.File)
	SetStderr(file *os.File)
	SetStdin(file *os.File)
	SetSysProcAttr(sysProcAttr *syscall.SysProcAttr)
	PID() int
}

type CommandFunc

type CommandFunc func(ctx context.Context, command string, args ...string) Command

func DefaultCommandFunc

func DefaultCommandFunc() CommandFunc

type CommandWrapper

type CommandWrapper struct {
	Wrapped *exec.Cmd
}

func (CommandWrapper) CombinedOutput

func (cmd CommandWrapper) CombinedOutput() ([]byte, error)

func (CommandWrapper) Err

func (cmd CommandWrapper) Err() error

func (CommandWrapper) PID

func (cmd CommandWrapper) PID() int

func (CommandWrapper) SetStderr

func (cmd CommandWrapper) SetStderr(file *os.File)

func (CommandWrapper) SetStdin

func (cmd CommandWrapper) SetStdin(file *os.File)

func (CommandWrapper) SetStdout

func (cmd CommandWrapper) SetStdout(file *os.File)

func (CommandWrapper) SetSysProcAttr

func (cmd CommandWrapper) SetSysProcAttr(sysProcAttr *syscall.SysProcAttr)

func (CommandWrapper) Start

func (cmd CommandWrapper) Start() error

func (CommandWrapper) Wait

func (cmd CommandWrapper) Wait() error

type Decoder

type Decoder interface {
	Decode(data any) error
}

type DecoderFactory

type DecoderFactory interface {
	Decoder(r io.Reader) Decoder
}

type DefaultDecoderFactory

type DefaultDecoderFactory struct{}

func (DefaultDecoderFactory) Decoder

func (factory DefaultDecoderFactory) Decoder(r io.Reader) Decoder

type DefaultEncoderFactory

type DefaultEncoderFactory struct{}

func (DefaultEncoderFactory) Encoder

func (factory DefaultEncoderFactory) Encoder(w io.Writer) Encoder

type DefaultOsProxy

type DefaultOsProxy struct{}

func (DefaultOsProxy) Create

func (d DefaultOsProxy) Create(name string) (*os.File, error)

func (DefaultOsProxy) Executable

func (d DefaultOsProxy) Executable() (string, error)

func (DefaultOsProxy) FindProcess

func (d DefaultOsProxy) FindProcess(pid int) (*os.Process, error)

func (DefaultOsProxy) Getwd

func (d DefaultOsProxy) Getwd() (string, error)

func (DefaultOsProxy) Hostname

func (d DefaultOsProxy) Hostname() (string, error)

func (DefaultOsProxy) MkdirAll

func (d DefaultOsProxy) MkdirAll(pth string, perm os.FileMode) error

func (DefaultOsProxy) OpenFile

func (d DefaultOsProxy) OpenFile(name string, flag int, perm os.FileMode) (*os.File, error)

func (DefaultOsProxy) ReadFileIfExists

func (d DefaultOsProxy) ReadFileIfExists(pth string) (string, bool, error)

func (DefaultOsProxy) Remove

func (d DefaultOsProxy) Remove(name string) error

func (DefaultOsProxy) Stat

func (d DefaultOsProxy) Stat(name string) (os.FileInfo, error)

func (DefaultOsProxy) TempDir

func (d DefaultOsProxy) TempDir() string

func (DefaultOsProxy) UserHomeDir

func (d DefaultOsProxy) UserHomeDir() (string, error)

func (DefaultOsProxy) WriteFile

func (d DefaultOsProxy) WriteFile(name string, data []byte, perm os.FileMode) error

type Encoder

type Encoder interface {
	SetIndent(prefix, indent string)
	SetEscapeHTML(escape bool)
	Encode(data any) error
}

type EncoderFactory

type EncoderFactory interface {
	Encoder(w io.Writer) Encoder
}

type OsProxy

type OsProxy interface {
	Create(name string) (*os.File, error)
	Executable() (string, error)
	FindProcess(pid int) (*os.Process, error)
	Getwd() (string, error)
	Hostname() (string, error)
	MkdirAll(name string, mode os.FileMode) error
	OpenFile(name string, flag int, perm os.FileMode) (*os.File, error)
	ReadFileIfExists(name string) (string, bool, error)
	Remove(name string) error
	Stat(pth string) (os.FileInfo, error)
	TempDir() string
	UserHomeDir() (string, error)
	WriteFile(name string, data []byte, mode os.FileMode) error
}

type TemplateProxy

type TemplateProxy struct {
	Parse   func(name string, templateText string) (*template.Template, error)
	Execute func(*template.Template, *bytes.Buffer, interface{}) error
}

func DefaultTemplateProxy

func DefaultTemplateProxy() TemplateProxy