decompressorv3

Documentation

Index

• Variables
• type Gzip
  • func (*Gzip) Descriptor() ([]byte, []int)
  • func (x *Gzip) GetChunkSize() *wrappers.UInt32Value
  • func (x *Gzip) GetMaxInflateRatio() *wrappers.UInt32Value
  • func (x *Gzip) GetWindowBits() *wrappers.UInt32Value
  • func (*Gzip) ProtoMessage()
  • func (x *Gzip) ProtoReflect() protoreflect.Message
  • func (x *Gzip) Reset()
  • func (x *Gzip) String() string
  • func (m *Gzip) Validate() error
  • func (m *Gzip) ValidateAll() error
• type GzipMultiError
  • func (m GzipMultiError) AllErrors() []error
  • func (m GzipMultiError) Error() string
• type GzipValidationError
  • func (e GzipValidationError) Cause() error
  • func (e GzipValidationError) Error() string
  • func (e GzipValidationError) ErrorName() string
  • func (e GzipValidationError) Field() string
  • func (e GzipValidationError) Key() bool
  • func (e GzipValidationError) Reason() string

Variables

var File_envoy_extensions_compression_gzip_decompressor_v3_gzip_proto protoreflect.FileDescriptor

Types

type Gzip

type Gzip struct {

	// Value from 9 to 15 that represents the base two logarithmic of the decompressor's window size.
	// The decompression window size needs to be equal or larger than the compression window size.
	// The default window size is 15.
	// This is so that the decompressor can decompress a response compressed by a compressor with any compression window size.
	// For more details about this parameter, please refer to `zlib manual <https://www.zlib.net/manual.html>`_ > inflateInit2.
	WindowBits *wrappers.UInt32Value `protobuf:"bytes,1,opt,name=window_bits,json=windowBits,proto3" json:"window_bits,omitempty"`
	// Value for zlib's decompressor output buffer. If not set, defaults to 4096.
	// See https://www.zlib.net/manual.html for more details.
	ChunkSize *wrappers.UInt32Value `protobuf:"bytes,2,opt,name=chunk_size,json=chunkSize,proto3" json:"chunk_size,omitempty"`
	// An upper bound to the number of times the output buffer is allowed to be bigger than the size of
	// the accumulated input. This value is used to prevent decompression bombs. If not set, defaults to 100.
	// [#comment:TODO(rojkov): Re-design the Decompressor interface to handle compression bombs gracefully instead of this quick solution.
	// See https://github.com/envoyproxy/envoy/commit/d4c39e635603e2f23e1e08ddecf5a5fb5a706338 for details.]
	MaxInflateRatio *wrappers.UInt32Value `protobuf:"bytes,3,opt,name=max_inflate_ratio,json=maxInflateRatio,proto3" json:"max_inflate_ratio,omitempty"`
	// contains filtered or unexported fields
}

func (*Gzip) Descriptor

func (*Gzip) Descriptor() ([]byte, []int)

Deprecated: Use Gzip.ProtoReflect.Descriptor instead.

func (*Gzip) GetChunkSize

func (x *Gzip) GetChunkSize() *wrappers.UInt32Value

func (*Gzip) GetMaxInflateRatio

func (x *Gzip) GetMaxInflateRatio() *wrappers.UInt32Value

func (*Gzip) GetWindowBits

func (x *Gzip) GetWindowBits() *wrappers.UInt32Value

func (*Gzip) ProtoMessage

func (*Gzip) ProtoMessage()

func (*Gzip) ProtoReflect

func (x *Gzip) ProtoReflect() protoreflect.Message

func (*Gzip) Reset

func (x *Gzip) Reset()

func (*Gzip) String

func (x *Gzip) String() string

func (*Gzip) Validate

func (m *Gzip) Validate() error

Validate checks the field values on Gzip with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Gzip) ValidateAll

func (m *Gzip) ValidateAll() error

ValidateAll checks the field values on Gzip with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in GzipMultiError, or nil if none found.

type GzipMultiError

type GzipMultiError []error

GzipMultiError is an error wrapping multiple validation errors returned by Gzip.ValidateAll() if the designated constraints aren't met.

func (GzipMultiError) AllErrors

func (m GzipMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (GzipMultiError) Error

func (m GzipMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type GzipValidationError

type GzipValidationError struct {
	// contains filtered or unexported fields
}

GzipValidationError is the validation error returned by Gzip.Validate if the designated constraints aren't met.

func (GzipValidationError) Cause

func (e GzipValidationError) Cause() error

Cause function returns cause value.

func (GzipValidationError) Error

func (e GzipValidationError) Error() string

Error satisfies the builtin error interface

func (GzipValidationError) ErrorName

func (e GzipValidationError) ErrorName() string

ErrorName returns error name.

func (GzipValidationError) Field

func (e GzipValidationError) Field() string

Field function returns field value.

func (GzipValidationError) Key

func (e GzipValidationError) Key() bool

Key function returns key value.

func (GzipValidationError) Reason

func (e GzipValidationError) Reason() string

Reason function returns reason value.