xzwriter

README

xzwriter: a trivial Go library for compressing with XZ.

Package xzwriter provides a writer XZWriter that pipes through an external XZ compressor.

Expects the Tukaani XZ tool in $PATH. See the XZ Utils home page: http://tukaani.org/xz/

License

As this is a trivial convenience package, you should probably not import this. Anyway licensed under the Apache License, Version 2.0.

See also

https://github.com/ulikunitz/xz

Documentation

Overview

Package xzwriter provides a WriteCloser XZWriter that pipes through an external XZ compressor.

Expects the Tukaani XZ tool in $PATH. See the XZ Utils home page: <http://tukaani.org/xz/>

Index

• type XZWriter
  • func New(w io.Writer) (xzwriter *XZWriter, err error)
  • func NewWithContext(ctx context.Context, w io.Writer) (*XZWriter, error)
  • func (xz *XZWriter) Close() error
  • func (xz *XZWriter) Write(p []byte) (n int, err error)

Types

type XZWriter

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

XZWriter is a WriteCloser that wraps a writer around an XZ compressor.

func New

func New(w io.Writer) (xzwriter *XZWriter, err error)

New returns an XZWriter, wrapping the writer w.

func NewWithContext

func NewWithContext(ctx context.Context, w io.Writer) (*XZWriter, error)

NewWithContext returns an XZWriter, wrapping the writer w. The context may be used to cancel or timeout the external compressor process.

The context can be used to kill the external process early. You still need to call Close() to clean up ressources. Alternatively you may call Close() prematurely.

func (*XZWriter) Close

func (xz *XZWriter) Close() error

Close implements the io.Closer interface.

func (*XZWriter) Write

func (xz *XZWriter) Write(p []byte) (n int, err error)

Write implements the io.Writer interface.