zstd

Documentation

Overview

Package github.com/mostynb/go-grpc-compression/zstd is a wrapper for using github.com/klauspost/compress/zstd with gRPC.

If you import this package, it will register itself as the encoder for the "zstd" compressor, overriding any previously registered compressors with this name.

If you don't want to override previously registered "zstd" compressors, then you should instead import github.com/mostynb/go-grpc-compression/nonclobbering/zstd

Index

• Constants
• Variables
• func SetLevel(level zstd.EncoderLevel) error

Constants

const Name = internalzstd.Name

Variables

var ErrNotInUse = internalzstd.ErrNotInUse

Functions

func SetLevel

func SetLevel(level zstd.EncoderLevel) error

SetLevel updates the registered compressor to use a particular compression level. Returns ErrNotInUse if this module isn't registered (because it has been overridden by another encoder with the same name), or any error returned by zstd.NewWriter(nil, zstd.WithEncoderLevel(level).

NOTE: this function is not threadsafe and must only be called from an init function or from the main goroutine before any other goroutines have been created.