compressorv3

Documentation

Index

• Variables
• type Brotli
  • func (*Brotli) Descriptor() ([]byte, []int)
  • func (x *Brotli) GetChunkSize() *wrapperspb.UInt32Value
  • func (x *Brotli) GetDisableLiteralContextModeling() bool
  • func (x *Brotli) GetEncoderMode() Brotli_EncoderMode
  • func (x *Brotli) GetInputBlockBits() *wrapperspb.UInt32Value
  • func (x *Brotli) GetQuality() *wrapperspb.UInt32Value
  • func (x *Brotli) GetWindowBits() *wrapperspb.UInt32Value
  • func (*Brotli) ProtoMessage()
  • func (x *Brotli) ProtoReflect() protoreflect.Message
  • func (x *Brotli) Reset()
  • func (x *Brotli) String() string
  • func (m *Brotli) Validate() error
  • func (m *Brotli) ValidateAll() error
• type BrotliMultiError
  • func (m BrotliMultiError) AllErrors() []error
  • func (m BrotliMultiError) Error() string
• type BrotliValidationError
  • func (e BrotliValidationError) Cause() error
  • func (e BrotliValidationError) Error() string
  • func (e BrotliValidationError) ErrorName() string
  • func (e BrotliValidationError) Field() string
  • func (e BrotliValidationError) Key() bool
  • func (e BrotliValidationError) Reason() string
• type Brotli_EncoderMode
  • func (Brotli_EncoderMode) Descriptor() protoreflect.EnumDescriptor
  • func (x Brotli_EncoderMode) Enum() *Brotli_EncoderMode
  • func (Brotli_EncoderMode) EnumDescriptor() ([]byte, []int)
  • func (x Brotli_EncoderMode) Number() protoreflect.EnumNumber
  • func (x Brotli_EncoderMode) String() string
  • func (Brotli_EncoderMode) Type() protoreflect.EnumType

Variables

var (
	Brotli_EncoderMode_name = map[int32]string{
		0: "DEFAULT",
		1: "GENERIC",
		2: "TEXT",
		3: "FONT",
	}
	Brotli_EncoderMode_value = map[string]int32{
		"DEFAULT": 0,
		"GENERIC": 1,
		"TEXT":    2,
		"FONT":    3,
	}
)

Enum value maps for Brotli_EncoderMode.

var File_envoy_extensions_compression_brotli_compressor_v3_brotli_proto protoreflect.FileDescriptor

Types

type Brotli

type Brotli struct {

	// Value from 0 to 11 that controls the main compression speed-density lever.
	// The higher quality, the slower compression. The default value is 3.
	Quality *wrapperspb.UInt32Value `protobuf:"bytes,1,opt,name=quality,proto3" json:"quality,omitempty"`
	// A value used to tune encoder for specific input. For more information about modes,
	// please refer to brotli manual: https://brotli.org/encode.html#aa6f
	// This field will be set to "DEFAULT" if not specified.
	EncoderMode Brotli_EncoderMode `` /* 169-byte string literal not displayed */
	// Value from 10 to 24 that represents the base two logarithmic of the compressor's window size.
	// Larger window results in better compression at the expense of memory usage. The default is 18.
	// For more details about this parameter, please refer to brotli manual:
	// https://brotli.org/encode.html#a9a8
	WindowBits *wrapperspb.UInt32Value `protobuf:"bytes,3,opt,name=window_bits,json=windowBits,proto3" json:"window_bits,omitempty"`
	// Value from 16 to 24 that represents the base two logarithmic of the compressor's input block
	// size. Larger input block results in better compression at the expense of memory usage. The
	// default is 24. For more details about this parameter, please refer to brotli manual:
	// https://brotli.org/encode.html#a9a8
	InputBlockBits *wrapperspb.UInt32Value `protobuf:"bytes,4,opt,name=input_block_bits,json=inputBlockBits,proto3" json:"input_block_bits,omitempty"`
	// Value for compressor's next output buffer. If not set, defaults to 4096.
	ChunkSize *wrapperspb.UInt32Value `protobuf:"bytes,5,opt,name=chunk_size,json=chunkSize,proto3" json:"chunk_size,omitempty"`
	// If true, disables "literal context modeling" format feature.
	// This flag is a "decoding-speed vs compression ratio" trade-off.
	DisableLiteralContextModeling bool `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

[#next-free-field: 7]

func (*Brotli) Descriptor

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

Deprecated: Use Brotli.ProtoReflect.Descriptor instead.

func (*Brotli) GetChunkSize

func (x *Brotli) GetChunkSize() *wrapperspb.UInt32Value

func (*Brotli) GetDisableLiteralContextModeling

func (x *Brotli) GetDisableLiteralContextModeling() bool

func (*Brotli) GetEncoderMode

func (x *Brotli) GetEncoderMode() Brotli_EncoderMode

func (*Brotli) GetInputBlockBits

func (x *Brotli) GetInputBlockBits() *wrapperspb.UInt32Value

func (*Brotli) GetQuality

func (x *Brotli) GetQuality() *wrapperspb.UInt32Value

func (*Brotli) GetWindowBits

func (x *Brotli) GetWindowBits() *wrapperspb.UInt32Value

func (*Brotli) ProtoMessage

func (*Brotli) ProtoMessage()

func (*Brotli) ProtoReflect

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

func (*Brotli) Reset

func (x *Brotli) Reset()

func (*Brotli) String

func (x *Brotli) String() string

func (*Brotli) Validate

func (m *Brotli) Validate() error

Validate checks the field values on Brotli 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 (*Brotli) ValidateAll

func (m *Brotli) ValidateAll() error

ValidateAll checks the field values on Brotli 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 BrotliMultiError, or nil if none found.

type BrotliMultiError

type BrotliMultiError []error

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

func (BrotliMultiError) AllErrors

func (m BrotliMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (BrotliMultiError) Error

func (m BrotliMultiError) Error() string

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

type BrotliValidationError

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

BrotliValidationError is the validation error returned by Brotli.Validate if the designated constraints aren't met.

func (BrotliValidationError) Cause

func (e BrotliValidationError) Cause() error

Cause function returns cause value.

func (BrotliValidationError) Error

func (e BrotliValidationError) Error() string

Error satisfies the builtin error interface

func (BrotliValidationError) ErrorName

func (e BrotliValidationError) ErrorName() string

ErrorName returns error name.

func (BrotliValidationError) Field

func (e BrotliValidationError) Field() string

Field function returns field value.

func (BrotliValidationError) Key

func (e BrotliValidationError) Key() bool

Key function returns key value.

func (BrotliValidationError) Reason

func (e BrotliValidationError) Reason() string

Reason function returns reason value.

type Brotli_EncoderMode

type Brotli_EncoderMode int32

const (
	Brotli_DEFAULT Brotli_EncoderMode = 0
	Brotli_GENERIC Brotli_EncoderMode = 1
	Brotli_TEXT    Brotli_EncoderMode = 2
	Brotli_FONT    Brotli_EncoderMode = 3
)

func (Brotli_EncoderMode) Descriptor

func (Brotli_EncoderMode) Descriptor() protoreflect.EnumDescriptor

func (Brotli_EncoderMode) Enum

func (x Brotli_EncoderMode) Enum() *Brotli_EncoderMode

func (Brotli_EncoderMode) EnumDescriptor

func (Brotli_EncoderMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use Brotli_EncoderMode.Descriptor instead.

func (Brotli_EncoderMode) Number

func (x Brotli_EncoderMode) Number() protoreflect.EnumNumber

func (Brotli_EncoderMode) String

func (x Brotli_EncoderMode) String() string

func (Brotli_EncoderMode) Type

func (Brotli_EncoderMode) Type() protoreflect.EnumType