ioutil

Documentation

Index

• func CompressByFileType(file string, out io.WriteCloser) io.WriteCloser
• func IsGzip(path string) bool
• func OpenCompressed(file string, flag int, perm os.FileMode) (io.WriteCloser, error)
• func OpenDecompressed(path string) (io.ReadCloser, error)
• func WriteCompressedBytes(file string, data []byte, flag int, perm os.FileMode) error
• func WriteCompressedJson(file string, obj any) error
• type Aborter
• type AtomicWriter
  • func NewAtomicWriter(path string, perm os.FileMode) (*AtomicWriter, error)
  • func NewAtomicWriterCompressed(path string, perm os.FileMode) (*AtomicWriter, error)
  • func (a *AtomicWriter) Abort() error
  • func (a *AtomicWriter) Close() error
  • func (a *AtomicWriter) Write(p []byte) (n int, err error)
• type OutputTarget
  • func NoOutputStream() OutputTarget
  • func ToAtomicFile(path string, perm os.FileMode) OutputTarget
  • func ToStdOut() OutputTarget
  • func ToStdOutOrFileOrNoop(outputPath string, perm os.FileMode) OutputTarget
• type WrappedReadCloser
  • func NewWrappedReadCloser(r io.ReadCloser, c io.Closer) *WrappedReadCloser
  • func (g *WrappedReadCloser) Close() error
• type WrappedWriteCloser
  • func NewWrappedWriteCloser(r io.WriteCloser, c io.Closer) *WrappedWriteCloser
  • func (g *WrappedWriteCloser) Close() error

Functions

func CompressByFileType

func CompressByFileType(file string, out io.WriteCloser) io.WriteCloser

func IsGzip

func IsGzip(path string) bool

IsGzip determines if a path points to a gzip compressed file. Returns true when the file has a .gz extension.

func OpenCompressed

func OpenCompressed(file string, flag int, perm os.FileMode) (io.WriteCloser, error)

OpenCompressed opens a file for writing and automatically compresses the content if the filename ends with .gz

func OpenDecompressed

func OpenDecompressed(path string) (io.ReadCloser, error)

OpenDecompressed opens a reader for the specified file and automatically gzip decompresses the content if the filename ends with .gz

func WriteCompressedBytes

func WriteCompressedBytes(file string, data []byte, flag int, perm os.FileMode) error

WriteCompressedBytes writes a byte slice to the specified file. If the filename ends with .gz, a byte slice is compressed and written.

func WriteCompressedJson

func WriteCompressedJson(file string, obj any) error

WriteCompressedJson writes the object to the specified file as a compressed json object if the filename ends with .gz.

Types

type Aborter

type Aborter func()

type AtomicWriter

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

func NewAtomicWriter

func NewAtomicWriter(path string, perm os.FileMode) (*AtomicWriter, error)

NewAtomicWriter creates a io.WriteCloser that performs an atomic write. The contents are initially written to a temporary file and only renamed into place when the writer is closed. NOTE: It's vital to check if an error is returned from Close() as it may indicate the file could not be renamed

func NewAtomicWriterCompressed

func NewAtomicWriterCompressed(path string, perm os.FileMode) (*AtomicWriter, error)

NewAtomicWriterCompressed creates a io.WriteCloser that performs an atomic write. The contents are initially written to a temporary file and only renamed into place when the writer is closed. NOTE: It's vital to check if an error is returned from Close() as it may indicate the file could not be renamed If path ends in .gz the contents written will be gzipped.

func (*AtomicWriter) Abort

func (a *AtomicWriter) Abort() error

Abort releases any open resources and cleans up temporary files without renaming them into place. Does nothing if the writer has already been closed.

func (*AtomicWriter) Close

func (a *AtomicWriter) Close() error

func (*AtomicWriter) Write

func (a *AtomicWriter) Write(p []byte) (n int, err error)

type OutputTarget

type OutputTarget func() (io.Writer, io.Closer, Aborter, error)

func NoOutputStream

func NoOutputStream() OutputTarget

func ToAtomicFile

func ToAtomicFile(path string, perm os.FileMode) OutputTarget

func ToStdOut

func ToStdOut() OutputTarget

func ToStdOutOrFileOrNoop

func ToStdOutOrFileOrNoop(outputPath string, perm os.FileMode) OutputTarget

type WrappedReadCloser

type WrappedReadCloser struct {
	io.ReadCloser
	// contains filtered or unexported fields
}

WrappedReadCloser is a struct that closes both the gzip.Reader and the underlying io.Closer.

func NewWrappedReadCloser

func NewWrappedReadCloser(r io.ReadCloser, c io.Closer) *WrappedReadCloser

NewWrappedReadCloser is a constructor function that initializes a WrappedReadCloser structure.

func (*WrappedReadCloser) Close

func (g *WrappedReadCloser) Close() error

Close closes both the gzip.Reader and the underlying reader.

type WrappedWriteCloser

type WrappedWriteCloser struct {
	io.WriteCloser
	// contains filtered or unexported fields
}

WrappedWriteCloser is a struct that closes both the gzip.Writer and the underlying io.Closer.

func NewWrappedWriteCloser

func NewWrappedWriteCloser(r io.WriteCloser, c io.Closer) *WrappedWriteCloser

NewWrappedWriteCloser is a constructor function that initializes a WrappedWriteCloser structure.

func (*WrappedWriteCloser) Close

func (g *WrappedWriteCloser) Close() error

Close closes both the gzip.Writer and the underlying writer.