compress

Documentation

Overview

Package compress provides compressor interface

Package compress provides compress functions

Package compress provides compress functions

Package compress provides compress functions

Package compress provides compress functions

Package compress provides compress functions

Package compress provides compress functions

Copyright (C) 2019-2023 vdaas.org vald team <vald@vdaas.org>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Package compress provides compress functions

Package compress provides compress functions

Index

• type Compressor
  • func NewGob(opts ...GobOption) (Compressor, error)
  • func NewGzip(opts ...GzipOption) (Compressor, error)
  • func NewLZ4(opts ...LZ4Option) (Compressor, error)
  • func NewZstd(opts ...ZstdOption) (Compressor, error)
• type GobOption
• type GzipOption
  • func WithGzipCompressionLevel(level int) GzipOption
  • func WithGzipGob(opts ...GobOption) GzipOption
• type LZ4Option
  • func WithLZ4CompressionLevel(level int) LZ4Option
  • func WithLZ4Gob(opts ...GobOption) LZ4Option
• type MockCompressor
  • func (m *MockCompressor) CompressVector(vector []float32) (bytes []byte, err error)
  • func (m *MockCompressor) DecompressVector(bytes []byte) (vector []float32, err error)
  • func (m *MockCompressor) Reader(src io.ReadCloser) (io.ReadCloser, error)
  • func (m *MockCompressor) Writer(dst io.WriteCloser) (io.WriteCloser, error)
• type MockReadCloser
  • func (m *MockReadCloser) Close() error
  • func (m *MockReadCloser) Read(p []byte) (int, error)
• type MockWriteCloser
  • func (m *MockWriteCloser) Close() error
  • func (m *MockWriteCloser) Write(p []byte) (int, error)
• type ZstdOption
  • func WithZstdCompressionLevel(level int) ZstdOption
  • func WithZstdGob(opts ...GobOption) ZstdOption

Types

type Compressor

type Compressor interface {
	CompressVector(vector []float32) (bytes []byte, err error)
	DecompressVector(bytes []byte) (vector []float32, err error)
	Reader(src io.ReadCloser) (io.ReadCloser, error)
	Writer(dst io.WriteCloser) (io.WriteCloser, error)
}

func NewGob

func NewGob(opts ...GobOption) (Compressor, error)

NewGob returns a Compressor implemented using gob.

func NewGzip

func NewGzip(opts ...GzipOption) (Compressor, error)

NewGzip returns Compressor implementation.

func NewLZ4

func NewLZ4(opts ...LZ4Option) (Compressor, error)

NewLZ4 returns Compressor implementation.

func NewZstd

func NewZstd(opts ...ZstdOption) (Compressor, error)

NewZstd returns the zstd compressor object or any initialization error.

type GobOption

type GobOption func(c *gobCompressor) error

type GzipOption

type GzipOption func(c *gzipCompressor) error

GzipOption represents the functional option for gzipCompressor.

func WithGzipCompressionLevel

func WithGzipCompressionLevel(level int) GzipOption

WithGzipCompressionLevel represents the option to set the compress level for gzip.

func WithGzipGob

func WithGzipGob(opts ...GobOption) GzipOption

WithGzipGob represents the option to set the GobOption to initialize Gob.

type LZ4Option

type LZ4Option func(c *lz4Compressor) error

LZ4Option represents the functional option for lz4Compressor.

func WithLZ4CompressionLevel

func WithLZ4CompressionLevel(level int) LZ4Option

WithLZ4CompressionLevel returns the option to set compressionLevel for lz4Compressor.

func WithLZ4Gob

func WithLZ4Gob(opts ...GobOption) LZ4Option

WithLZ4Gob returns the option to set gobc for lz4Compressor.

type MockCompressor

type MockCompressor struct {
	CompressVectorFunc   func(vector []float32) (bytes []byte, err error)
	DecompressVectorFunc func(bytes []byte) (vector []float32, err error)
	ReaderFunc           func(src io.ReadCloser) (io.ReadCloser, error)
	WriterFunc           func(dst io.WriteCloser) (io.WriteCloser, error)
}

MockCompressor represents mock of Compressor.

func (*MockCompressor) CompressVector

func (m *MockCompressor) CompressVector(vector []float32) (bytes []byte, err error)

CompressVector calls CompressVectorFunc.

func (*MockCompressor) DecompressVector

func (m *MockCompressor) DecompressVector(bytes []byte) (vector []float32, err error)

DecompressVector calls DecompressVectorFunc.

func (*MockCompressor) Reader

func (m *MockCompressor) Reader(src io.ReadCloser) (io.ReadCloser, error)

Reader calls ReaderFunc.

func (*MockCompressor) Writer

func (m *MockCompressor) Writer(dst io.WriteCloser) (io.WriteCloser, error)

Writer calls WriterFunc.

type MockReadCloser

type MockReadCloser struct {
	ReadFunc  func(p []byte) (n int, err error)
	CloseFunc func() error
}

MockReadCloser represents mock of ReadCloser.

func (*MockReadCloser) Close

func (m *MockReadCloser) Close() error

Close calls CloseFunc.

func (*MockReadCloser) Read

func (m *MockReadCloser) Read(p []byte) (int, error)

Read calls ReadFunc.

type MockWriteCloser

type MockWriteCloser struct {
	WriteFunc func(p []byte) (n int, err error)
	CloseFunc func() error
}

MockWriteCloser represents mock of WriteCloser.

func (*MockWriteCloser) Close

func (m *MockWriteCloser) Close() error

Close calls CloseFunc.

func (*MockWriteCloser) Write

func (m *MockWriteCloser) Write(p []byte) (int, error)

Write calls WriterFunc.

type ZstdOption

type ZstdOption func(c *zstdCompressor) error

ZstdOption represents the functional option for zstdCompressor.

func WithZstdCompressionLevel

func WithZstdCompressionLevel(level int) ZstdOption

WithZstdCompressionLevel represents the option to set the compress level for zstd.

func WithZstdGob

func WithZstdGob(opts ...GobOption) ZstdOption

WithZstdGob represents the option to set the GobOption to initialize Gob.