iox

Documentation

Index

• Constants
• Variables
• func AppendToFile(s, target string) error
• func CheckDirIsEmpty(target string) error
• func CopyBufferToFile(b bytes.Buffer, target string) error
• func CopyFile(src, dst string) error
• func CopyRecursive(src fs.FS, dest string) error
• func EnsureDir(fileName string) error
• func MultiWriterTransform(writers ...WriterTransform) io.Writer
• func WriteFile(target string, data []byte) error
• type NullWriter
  • func NewNullWriter() *NullWriter
  • func (*NullWriter) Write(_ []byte) (int, error)
• type Prompter
  • func NewPrompter(r *bufio.Reader) *Prompter
  • func (p *Prompter) Ask(w string) (bool, error)
• type WriterTransform

Constants

const (
	FullPermAccess   = 0o755
	UserGroupPerm    = 0o750
	FullRWPermAccess = 0o600
	RWPermAccess     = 0o644
)

Variables

var (
	ErrEmptyFile = errors.New("trimming buffer resulted in an empty file")
)

var ErrWriterTransform = errors.New("writer transform error")

Functions

func AppendToFile

func AppendToFile(s, target string) error

func CheckDirIsEmpty

func CheckDirIsEmpty(target string) error

func CopyBufferToFile

func CopyBufferToFile(b bytes.Buffer, target string) error

func CopyFile

func CopyFile(src, dst string) error

func CopyRecursive

func CopyRecursive(src fs.FS, dest string) error

func EnsureDir

func EnsureDir(fileName string) error

EnsureDir creates the directories to host the file. Example: hello/world.md will create the hello dir if it does not exist.

func MultiWriterTransform

func MultiWriterTransform(writers ...WriterTransform) io.Writer

func WriteFile

func WriteFile(target string, data []byte) error

Types

type NullWriter

type NullWriter struct{}

func NewNullWriter

func NewNullWriter() *NullWriter

func (*NullWriter) Write

func (*NullWriter) Write(_ []byte) (int, error)

type Prompter

type Prompter struct {
	Reader *bufio.Reader
}

func NewPrompter

func NewPrompter(r *bufio.Reader) *Prompter

func (*Prompter) Ask

func (p *Prompter) Ask(w string) (bool, error)

type WriterTransform

type WriterTransform struct {
	W          io.Writer
	Transforms []bytesx.TransformFunc
}