brotliKit

Documentation

Index

• Constants
• Variables
• func AssertValidLevel(level int) error
• func Compress(data []byte, options ...Lz4Option) (compressed []byte, err error)
• func Decompress(compressed []byte) ([]byte, error)
• func IsValidLevel(level int) bool
• type Config
• type Lz4Option
  • func WithCompressThreshold(compressThreshold int) Lz4Option
  • func WithLevel(level int) Lz4Option

Constants

const (
	LevelDefaultCompression = brotli.DefaultCompression

	LevelBestSpeed       = brotli.BestSpeed
	LevelBestCompression = brotli.BestCompression
)

Variables

var (
	NewWriter func(dst io.Writer) *brotli.Writer = brotli.NewWriter

	NewWriterWithLevel func(dst io.Writer, level int) *brotli.Writer = brotli.NewWriterLevel

	NewReader func(src io.Reader) *brotli.Reader = brotli.NewReader
)

Functions

func AssertValidLevel

func AssertValidLevel(level int) error

func Compress

func Compress(data []byte, options ...Lz4Option) (compressed []byte, err error)

Compress

PS: (1) 参考 github.com/andybalholm/brotli 中的 "example_test.go". (2) 前端的解压，可以参考 notes/_Vue3Projects/ws-client 中的 BrotliKit.

func Decompress

func Decompress(compressed []byte) ([]byte, error)

Decompress

PS: 参考 github.com/andybalholm/brotli 中的 "example_test.go".

func IsValidLevel

func IsValidLevel(level int) bool

IsValidLevel

@param level 有效范围: [0, 11]

Types

type Config

type Config struct {
	Level int `json:"level" yaml:"level" validate:"min=0,max=11"`

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

type Lz4Option

type Lz4Option func(opts *lz4Options)

func WithCompressThreshold

func WithCompressThreshold(compressThreshold int) Lz4Option

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

func WithLevel

func WithLevel(level int) Lz4Option