middleware

Documentation

Index

• func HTTPContentDecompressor(h http.Handler, opts ...DecompressorOption) http.Handler
• type CompressRoundTripper
  • func NewCompressRoundTripper(rt http.RoundTripper, compressionType CompressionType) *CompressRoundTripper
  • func (r *CompressRoundTripper) CompressionType() CompressionType
  • func (r *CompressRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)
• type CompressionType
  • func (ct *CompressionType) UnmarshalText(in []byte) error
• type DecompressorOption
  • func WithErrorHandler(e ErrorHandler) DecompressorOption
• type ErrorHandler
• type WrappedServerStream
  • func WrapServerStream(stream grpc.ServerStream) *WrappedServerStream
  • func (w *WrappedServerStream) Context() context.Context

Functions

func HTTPContentDecompressor

func HTTPContentDecompressor(h http.Handler, opts ...DecompressorOption) http.Handler

HTTPContentDecompressor is a middleware that offloads the task of handling compressed HTTP requests by identifying the compression format in the "Content-Encoding" header and re-writing request body so that the handlers further in the chain can work on decompressed data. It supports gzip and deflate/zlib compression.

Types

type CompressRoundTripper

type CompressRoundTripper struct {
	RoundTripper http.RoundTripper
	// contains filtered or unexported fields
}

func NewCompressRoundTripper

func NewCompressRoundTripper(rt http.RoundTripper, compressionType CompressionType) *CompressRoundTripper

func (*CompressRoundTripper) CompressionType

func (r *CompressRoundTripper) CompressionType() CompressionType

func (*CompressRoundTripper) RoundTrip

func (r *CompressRoundTripper) RoundTrip(req *http.Request) (*http.Response, error)

type CompressionType

type CompressionType string

const (
	CompressionGzip    CompressionType = "gzip"
	CompressionZlib    CompressionType = "zlib"
	CompressionDeflate CompressionType = "deflate"
	CompressionSnappy  CompressionType = "snappy"
	CompressionZstd    CompressionType = "zstd"
	CompressionNone    CompressionType = "none"
	CompressionEmpty   CompressionType = ""
)

func (*CompressionType) UnmarshalText

func (ct *CompressionType) UnmarshalText(in []byte) error

type DecompressorOption

type DecompressorOption func(d *decompressor)

func WithErrorHandler

func WithErrorHandler(e ErrorHandler) DecompressorOption

type ErrorHandler

type ErrorHandler func(w http.ResponseWriter, r *http.Request, errorMsg string, statusCode int)

type WrappedServerStream

type WrappedServerStream struct {
	grpc.ServerStream
	// WrappedContext is the wrapper's own Context. You can assign it.
	WrappedContext context.Context
}

WrappedServerStream is a thin wrapper around grpc.ServerStream that allows modifying context.

func WrapServerStream

func WrapServerStream(stream grpc.ServerStream) *WrappedServerStream

WrapServerStream returns a ServerStream that has the ability to overwrite context.

func (*WrappedServerStream) Context

func (w *WrappedServerStream) Context() context.Context

Context returns the wrapper's WrappedContext, overwriting the nested grpc.ServerStream.Context()