gzip

Documentation

Overview

Copyright (C) 2019-2024 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.

Copyright (C) 2019-2024 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.

Index

• Constants
• type Gzip
  • func New() Gzip
• type MockGzip
  • func (m *MockGzip) NewReader(r io.Reader) (Reader, error)
  • func (m *MockGzip) NewWriterLevel(w io.Writer, level int) (Writer, error)
• type MockReader
  • func (m *MockReader) Close() error
  • func (m *MockReader) Multistream(ok bool)
  • func (m *MockReader) Read(p []byte) (n int, err error)
  • func (m *MockReader) Reset(r io.Reader) error
• type MockWriter
  • func (m *MockWriter) Close() error
  • func (m *MockWriter) Flush() error
  • func (m *MockWriter) Reset(w io.Writer)
  • func (m *MockWriter) Write(p []byte) (n int, err error)
• type Reader
• type Writer

Constants

const (
	NoCompression       = gzip.NoCompression
	BestSpeed           = gzip.BestSpeed
	BestCompression     = gzip.BestCompression
	DefaultCompression  = gzip.DefaultCompression
	ConstantCompression = gzip.ConstantCompression
	HuffmanOnly         = gzip.HuffmanOnly
)

These constants are copied from the gzip package.

Types

type Gzip

type Gzip interface {
	NewReader(r io.Reader) (Reader, error)
	NewWriterLevel(w io.Writer, level int) (Writer, error)
}

Gzip is an interface to create Writer and Reader implementation.

func New

func New() Gzip

New returns Gzip implementation.

type MockGzip

type MockGzip struct {
	NewWriterLevelFunc func(w io.Writer, level int) (Writer, error)
	NewReaderFunc      func(r io.Reader) (Reader, error)
}

MockGzip represents mock struct of Gzip.

func (*MockGzip) NewReader

func (m *MockGzip) NewReader(r io.Reader) (Reader, error)

NewReader calls NewReaderFunc.

func (*MockGzip) NewWriterLevel

func (m *MockGzip) NewWriterLevel(w io.Writer, level int) (Writer, error)

NewWriterLevel calls NewWriterLevelFunc.

type MockReader

type MockReader struct {
	ReadFunc        func(p []byte) (n int, err error)
	CloseFunc       func() error
	ResetFunc       func(r io.Reader) error
	MultistreamFunc func(ok bool)
}

MockReader represents mock of Reader.

func (*MockReader) Close

func (m *MockReader) Close() error

Close calls CloseFunc.

func (*MockReader) Multistream

func (m *MockReader) Multistream(ok bool)

Multistream calls MultistreamFunc.

func (*MockReader) Read

func (m *MockReader) Read(p []byte) (n int, err error)

Read calls ReadFunc.

func (*MockReader) Reset

func (m *MockReader) Reset(r io.Reader) error

Reset calls ResetFunc.

type MockWriter

type MockWriter struct {
	WriteFunc func(p []byte) (n int, err error)
	CloseFunc func() error
	ResetFunc func(w io.Writer)
	FlushFunc func() error
}

MockWriter represents mock of Writer.

func (*MockWriter) Close

func (m *MockWriter) Close() error

Close calls CloseFunc.

func (*MockWriter) Flush

func (m *MockWriter) Flush() error

Flush calls FlushFunc.

func (*MockWriter) Reset

func (m *MockWriter) Reset(w io.Writer)

Reset calls ResetFunc.

func (*MockWriter) Write

func (m *MockWriter) Write(p []byte) (n int, err error)

Write calls WriteFunc.

type Reader

type Reader interface {
	io.ReadCloser
	Reset(r io.Reader) error
	Multistream(ok bool)
}

Reader represents an interface for Reader of gzip.

type Writer

type Writer interface {
	io.WriteCloser
	Reset(w io.Writer)
	Flush() error
}

Writer represents an interface for Writer of gzip.