Documentation
¶
Index ¶
- Constants
- type Config
- func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage
- func (m *Config) CloneVT() *Config
- func (this *Config) EqualMessageVT(thatMsg any) bool
- func (this *Config) EqualVT(that *Config) bool
- func (c *Config) EqualsConfig(other config.Config) bool
- func (x *Config) GetBest() bool
- func (x *Config) GetBetter() bool
- func (c *Config) GetConfigID() string
- func (x *Config) MarshalJSON() ([]byte, error)
- func (x *Config) MarshalProtoJSON(s *json.MarshalState)
- func (x *Config) MarshalProtoText() string
- func (m *Config) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Config) MarshalToVT(dAtA []byte) (int, error)
- func (m *Config) MarshalVT() (dAtA []byte, err error)
- func (*Config) ProtoMessage()
- func (x *Config) Reset()
- func (m *Config) SizeVT() (n int)
- func (x *Config) String() string
- func (x *Config) UnmarshalJSON(b []byte) error
- func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)
- func (m *Config) UnmarshalVT(dAtA []byte) error
- func (c *Config) Validate() error
- type S2
- type StepFactory
Constants ¶
const ConfigID = "hydra/transform/s2"
ConfigID is the configuration identifier.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct {
// Better uses the "better" s2 mode.
// This is slightly slower.
Better bool `protobuf:"varint,1,opt,name=better,proto3" json:"better,omitempty"`
// Best uses the "best" s2 mode.
// This is very much slower than better.
Best bool `protobuf:"varint,2,opt,name=best,proto3" json:"best,omitempty"`
// contains filtered or unexported fields
}
Config configures the s2 transform.
func (*Config) CloneMessageVT ¶
func (m *Config) CloneMessageVT() protobuf_go_lite.CloneMessage
func (*Config) EqualMessageVT ¶
func (*Config) EqualsConfig ¶
EqualsConfig checks if the config is equal to another.
func (*Config) GetConfigID ¶
GetConfigID returns the unique string for this configuration type. This string is stored with the encoded config.
func (*Config) MarshalJSON ¶
MarshalJSON marshals the Config to JSON.
func (*Config) MarshalProtoJSON ¶
func (x *Config) MarshalProtoJSON(s *json.MarshalState)
MarshalProtoJSON marshals the Config message to JSON.
func (*Config) MarshalProtoText ¶
func (*Config) MarshalToSizedBufferVT ¶
func (*Config) ProtoMessage ¶
func (*Config) ProtoMessage()
func (*Config) UnmarshalJSON ¶
UnmarshalJSON unmarshals the Config from JSON.
func (*Config) UnmarshalProtoJSON ¶
func (x *Config) UnmarshalProtoJSON(s *json.UnmarshalState)
UnmarshalProtoJSON unmarshals the Config message from JSON.
func (*Config) UnmarshalVT ¶
type S2 ¶
type S2 struct {
// contains filtered or unexported fields
}
S2 is the S2 compression step.
func (*S2) DecodeBlock ¶
DecodeBlock decodes the block according to the config. May reuse the same byte slice if possible.
type StepFactory ¶
type StepFactory struct{}
StepFactory constructs the transform step.
func NewStepFactory ¶
func NewStepFactory() *StepFactory
NewStepFactory constructs the factory object.
func (*StepFactory) Construct ¶
func (f *StepFactory) Construct( conf config.Config, opts controller.ConstructOpts, ) (block_transform.Step, error)
Construct constructs the associated transform step given configuration.
func (*StepFactory) ConstructConfig ¶
func (f *StepFactory) ConstructConfig() config.Config
ConstructConfig constructs an instance of the transform configuration.
func (*StepFactory) ConstructMockConfig ¶
func (f *StepFactory) ConstructMockConfig() []config.Config
ConstructMockConfig constructs an instance of the transform configuration for testing.
func (*StepFactory) GetConfigID ¶
func (f *StepFactory) GetConfigID() string
GetConfigID returns the unique config ID for the transform step.
Source Files