gzipKit

Documentation

Index

• Constants
• Variables
• func AssertValidLevel(level int) error
• func CompressComplexly(data []byte, options ...GzipOption) ([]byte, error)
• func IsValidLevel(level int) bool
• type Config
• type GzipOption
  • func WithCompressThreshold(compressThreshold int) GzipOption
  • func WithLevel(level int) GzipOption

Constants

const (
	// DefaultLevel 默认的压缩级别，速度最快
	DefaultLevel = gzip.BestSpeed

	// DefaultCompressThreshold 默认的最小压缩长度阈值
	DefaultCompressThreshold = -1
)

const (
	LevelNoCompression = gzip.NoCompression

	LevelBestSpeed = gzip.BestSpeed

	LevelBestCompression = gzip.BestCompression
)

Variables

var (
	Compress func(data []byte, level ...int) ([]byte, error) = gcompress.Gzip

	Uncompress func(data []byte) ([]byte, error) = gcompress.UnGzip
)

var (
	GzipFile func(srcFilePath, dstFilePath string, level ...int) (err error) = gcompress.GzipFile

	GzipPathWriter func(filePath string, writer io.Writer, level ...int) error = gcompress.GzipPathWriter
)

var (
	UnGzipFile func(srcFilePath, dstFilePath string) error = gcompress.UnGzipFile
)

Functions

func AssertValidLevel

func AssertValidLevel(level int) error

func CompressComplexly

func CompressComplexly(data []byte, options ...GzipOption) ([]byte, error)

CompressComplexly

PS: 不涉及 compressThreshold 的话，建议直接使用 Compress.

func IsValidLevel

func IsValidLevel(level int) bool

IsValidLevel

@param level 有效范围: [-2, 9]

Types

type Config

type Config struct {
	Level int `json:"level" yaml:"level" validate:"min=-2,max=9"`

	CompressThreshold int `json:"compressThreshold" yaml:"compressThreshold"`
}

type GzipOption

type GzipOption func(opts *gzipOptions)

func WithCompressThreshold

func WithCompressThreshold(compressThreshold int) GzipOption

WithCompressThreshold 设置: 最小压缩长度阈值

func WithLevel

func WithLevel(level int) GzipOption