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 AtomicWriter
- type WrappedReadCloser
- type WrappedWriteCloser
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CompressByFileType ¶ added in v1.4.2
func CompressByFileType(file string, out io.WriteCloser) io.WriteCloser
func IsGzip ¶
IsGzip determines if a path points to a gzip compressed file. Returns true when the file has a .gz extension.
func OpenCompressed ¶
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 ¶ added in v1.7.4
WriteCompressedBytes writes a byte slice to the specified file. If the filename ends with .gz, a byte slice is compressed and written.
func WriteCompressedJson ¶
WriteCompressedJson writes the object to the specified file as a compressed json object if the filename ends with .gz.
Types ¶
type AtomicWriter ¶ added in v1.7.6
type AtomicWriter struct {
// contains filtered or unexported fields
}
func NewAtomicWriterCompressed ¶ added in v1.4.2
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 ¶ added in v1.7.6
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 ¶ added in v1.7.6
func (a *AtomicWriter) Close() error
type WrappedReadCloser ¶ added in v1.9.1
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 ¶ added in v1.9.1
func NewWrappedReadCloser(r io.ReadCloser, c io.Closer) *WrappedReadCloser
NewWrappedReadCloser is a constructor function that initializes a WrappedReadCloser structure.
func (*WrappedReadCloser) Close ¶ added in v1.9.1
func (g *WrappedReadCloser) Close() error
Close closes both the gzip.Reader and the underlying reader.
type WrappedWriteCloser ¶ added in v1.9.1
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 ¶ added in v1.9.1
func NewWrappedWriteCloser(r io.WriteCloser, c io.Closer) *WrappedWriteCloser
NewWrappedWriteCloser is a constructor function that initializes a WrappedWriteCloser structure.
func (*WrappedWriteCloser) Close ¶ added in v1.9.1
func (g *WrappedWriteCloser) Close() error
Close closes both the gzip.Writer and the underlying writer.