lib

README

zb64/lib

core library providing zip-base64-encoder/decoder.

Documentation

Overview

Package lib provides encoder and decoder for base64-encoded compressed string.

Index

• Variables
• type PlainReader
  • func NewPlainReader(r io.Reader) *PlainReader
  • func (*PlainReader) Close() error
  • func (r *PlainReader) Read(p []byte) (n int, err error)
• type PlainWriter
  • func NewPlainWriter(w io.Writer) *PlainWriter
  • func (*PlainWriter) Close() error
  • func (w *PlainWriter) Write(p []byte) (n int, err error)

Variables

var Deflate = newDataFormat(
	func(buf io.Writer) io.WriteCloser {
		w, _ := flate.NewWriter(buf, flate.BestCompression)
		return w
	},
	func(buf io.Reader) (io.ReadCloser, error) {
		return flate.NewReader(buf), nil
	},
)

Deflate is a wrapper of DEFLATE compressed data format, provided by compress/flate.

var LzwLSB = newDataFormat(
	func(buf io.Writer) io.WriteCloser {
		return lzw.NewWriter(buf, lzw.LSB, lzwLitWidth)
	},
	func(buf io.Reader) (io.ReadCloser, error) {
		return lzw.NewReader(buf, lzw.LSB, lzwLitWidth), nil
	},
)

LzwMSB is a wrapper of Lempel-Ziv-Welch compressed data format using Least Significant Bits, provided by compress/lzw.

var LzwMSB = newDataFormat(
	func(buf io.Writer) io.WriteCloser {
		return lzw.NewWriter(buf, lzw.MSB, lzwLitWidth)
	},
	func(buf io.Reader) (io.ReadCloser, error) {
		return lzw.NewReader(buf, lzw.MSB, lzwLitWidth), nil
	},
)

LzwMSB is a wrapper of Lempel-Ziv-Welch compressed data format using Most Significant Bits, provided by compress/lzw.

var Plain = newDataFormat(
	func(buf io.Writer) io.WriteCloser {
		return NewPlainWriter(buf)
	},
	func(buf io.Reader) (io.ReadCloser, error) {
		return NewPlainReader(buf), nil
	},
)

Plain is a wrapper of plain text format, no compression.

Types

type PlainReader

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

func NewPlainReader

func NewPlainReader(r io.Reader) *PlainReader

func (*PlainReader) Close

func (*PlainReader) Close() error

func (*PlainReader) Read

func (r *PlainReader) Read(p []byte) (n int, err error)

type PlainWriter

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

func NewPlainWriter

func NewPlainWriter(w io.Writer) *PlainWriter

func (*PlainWriter) Close

func (*PlainWriter) Close() error

func (*PlainWriter) Write

func (w *PlainWriter) Write(p []byte) (n int, err error)