compress

package

v0.0.0-...-bd62367 Latest Latest Go to latest Published: Dec 13, 2022 License: Apache-2.0 Imports: 8 Imported by: 1

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/hantmac/ch-go

Links

Open Source Insights

Documentation ¶

Overview ¶

Package compress implements compression support.

Index ¶

func FormatU128(v city.U128) string
func MethodStrings() []string
type CorruptedDataErr
- func (c *CorruptedDataErr) Error() string
type Method
- func MethodString(s string) (Method, error)
- func MethodValues() []Method
- func (i Method) IsAMethod() bool
- func (i Method) String() string
type Reader
- func NewReader(r io.Reader) *Reader
- func (r *Reader) Read(p []byte) (n int, err error)
type Writer
- func NewWriter() *Writer
- func (w *Writer) Compress(m Method, buf []byte) error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func FormatU128 ¶

func FormatU128(v city.U128) string

FormatU128 formats city.U128 as hex.

func MethodStrings ¶

func MethodStrings() []string

MethodStrings returns a slice of all String values of the enum

Types ¶

type CorruptedDataErr ¶

type CorruptedDataErr struct {
	Actual    city.U128
	Reference city.U128
	RawSize   int
	DataSize  int
}

CorruptedDataErr means that provided hash mismatch with calculated.

func (*CorruptedDataErr) Error ¶

func (c *CorruptedDataErr) Error() string

type Method ¶

type Method byte

Method is compression codec.

const (
	None Method = 0x02
	LZ4  Method = 0x82
	ZSTD Method = 0x90
)

Possible compression methods.

func MethodString ¶

func MethodString(s string) (Method, error)

MethodString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func MethodValues ¶

func MethodValues() []Method

MethodValues returns all values of the enum

func (Method) IsAMethod ¶

func (i Method) IsAMethod() bool

IsAMethod returns "true" if the value is listed in the enum definition. "false" otherwise

func (Method) String ¶

func (i Method) String() string

type Reader ¶

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

Reader decodes compressed blocks.

func NewReader ¶

func NewReader(r io.Reader) *Reader

NewReader returns new *Reader from r.

func (*Reader) Read ¶

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

Read implements io.Reader.

type Writer ¶

type Writer struct {
	Data []byte
	// contains filtered or unexported fields
}

Writer encodes compressed blocks.

func NewWriter ¶

func NewWriter() *Writer

func (*Writer) Compress ¶

func (w *Writer) Compress(m Method, buf []byte) error

Compress buf into Data.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL