v3alpha

package
v0.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 9, 2024 License: Apache-2.0 Imports: 19 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Qatzstd_Strategy_name = map[int32]string{
		0: "DEFAULT",
		1: "FAST",
		2: "DFAST",
		3: "GREEDY",
		4: "LAZY",
		5: "LAZY2",
		6: "BTLAZY2",
		7: "BTOPT",
		8: "BTULTRA",
		9: "BTULTRA2",
	}
	Qatzstd_Strategy_value = map[string]int32{
		"DEFAULT":  0,
		"FAST":     1,
		"DFAST":    2,
		"GREEDY":   3,
		"LAZY":     4,
		"LAZY2":    5,
		"BTLAZY2":  6,
		"BTOPT":    7,
		"BTULTRA":  8,
		"BTULTRA2": 9,
	}
)

Enum value maps for Qatzstd_Strategy.

View Source
var File_contrib_envoy_extensions_compression_qatzstd_compressor_v3alpha_qatzstd_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Qatzstd

type Qatzstd struct {

	// Set compression parameters according to pre-defined compression level table.
	// Note that exact compression parameters are dynamically determined,
	// depending on both compression level and source content size (when known).
	// Value 0 means default, and default level is 3.
	//
	// Setting a level does not automatically set all other compression parameters
	// to default. Setting this will however eventually dynamically impact the compression
	// parameters which have not been manually set. The manually set
	// ones will 'stick'.
	CompressionLevel *wrapperspb.UInt32Value `protobuf:"bytes,1,opt,name=compression_level,json=compressionLevel,proto3" json:"compression_level,omitempty"`
	// A 32-bits checksum of content is written at end of frame. If not set, defaults to false.
	EnableChecksum bool `protobuf:"varint,2,opt,name=enable_checksum,json=enableChecksum,proto3" json:"enable_checksum,omitempty"`
	// The higher the value of selected strategy, the more complex it is,
	// resulting in stronger and slower compression.
	//
	// Special: value 0 means "use default strategy".
	Strategy Qatzstd_Strategy `` /* 148-byte string literal not displayed */
	// 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"`
	// Enable QAT to accelerate Zstd compression or not. If not set, defaults to false.
	//
	// This is useful in the case that users want to enable QAT for a period of time and disable QAT for another period of time,
	// they don't have to change the config too much or prepare for another config that has software zstd compressor and just changing the value of this filed.
	EnableQatZstd bool `protobuf:"varint,6,opt,name=enable_qat_zstd,json=enableQatZstd,proto3" json:"enable_qat_zstd,omitempty"`
	// Fallback to software for Qatzstd when input size is less than this value.
	// Valid only “enable_qat_zstd“ is “true“. 0 means no fallback at all. If not set, defaults to 4000.
	QatZstdFallbackThreshold *wrapperspb.UInt32Value `` /* 137-byte string literal not displayed */
	// contains filtered or unexported fields
}

[#next-free-field: 8]

func (*Qatzstd) Descriptor deprecated

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

Deprecated: Use Qatzstd.ProtoReflect.Descriptor instead.

func (*Qatzstd) GetChunkSize

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

func (*Qatzstd) GetCompressionLevel

func (x *Qatzstd) GetCompressionLevel() *wrapperspb.UInt32Value

func (*Qatzstd) GetEnableChecksum

func (x *Qatzstd) GetEnableChecksum() bool

func (*Qatzstd) GetEnableQatZstd

func (x *Qatzstd) GetEnableQatZstd() bool

func (*Qatzstd) GetQatZstdFallbackThreshold

func (x *Qatzstd) GetQatZstdFallbackThreshold() *wrapperspb.UInt32Value

func (*Qatzstd) GetStrategy

func (x *Qatzstd) GetStrategy() Qatzstd_Strategy

func (*Qatzstd) ProtoMessage

func (*Qatzstd) ProtoMessage()

func (*Qatzstd) ProtoReflect

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

func (*Qatzstd) Reset

func (x *Qatzstd) Reset()

func (*Qatzstd) String

func (x *Qatzstd) String() string

func (*Qatzstd) Validate

func (m *Qatzstd) Validate() error

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

func (m *Qatzstd) ValidateAll() error

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

type QatzstdMultiError

type QatzstdMultiError []error

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

func (QatzstdMultiError) AllErrors

func (m QatzstdMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (QatzstdMultiError) Error

func (m QatzstdMultiError) Error() string

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

type QatzstdValidationError

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

QatzstdValidationError is the validation error returned by Qatzstd.Validate if the designated constraints aren't met.

func (QatzstdValidationError) Cause

func (e QatzstdValidationError) Cause() error

Cause function returns cause value.

func (QatzstdValidationError) Error

func (e QatzstdValidationError) Error() string

Error satisfies the builtin error interface

func (QatzstdValidationError) ErrorName

func (e QatzstdValidationError) ErrorName() string

ErrorName returns error name.

func (QatzstdValidationError) Field

func (e QatzstdValidationError) Field() string

Field function returns field value.

func (QatzstdValidationError) Key

func (e QatzstdValidationError) Key() bool

Key function returns key value.

func (QatzstdValidationError) Reason

func (e QatzstdValidationError) Reason() string

Reason function returns reason value.

type Qatzstd_Strategy

type Qatzstd_Strategy int32

Reference to http://facebook.github.io/zstd/zstd_manual.html

const (
	Qatzstd_DEFAULT  Qatzstd_Strategy = 0
	Qatzstd_FAST     Qatzstd_Strategy = 1
	Qatzstd_DFAST    Qatzstd_Strategy = 2
	Qatzstd_GREEDY   Qatzstd_Strategy = 3
	Qatzstd_LAZY     Qatzstd_Strategy = 4
	Qatzstd_LAZY2    Qatzstd_Strategy = 5
	Qatzstd_BTLAZY2  Qatzstd_Strategy = 6
	Qatzstd_BTOPT    Qatzstd_Strategy = 7
	Qatzstd_BTULTRA  Qatzstd_Strategy = 8
	Qatzstd_BTULTRA2 Qatzstd_Strategy = 9
)

func (Qatzstd_Strategy) Descriptor

func (Qatzstd_Strategy) Enum

func (Qatzstd_Strategy) EnumDescriptor deprecated

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

Deprecated: Use Qatzstd_Strategy.Descriptor instead.

func (Qatzstd_Strategy) Number

func (Qatzstd_Strategy) String

func (x Qatzstd_Strategy) String() string

func (Qatzstd_Strategy) Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL