config

Documentation

Index

• Variables
• func EqualsConfig[T vtcompare.EqualVT[T]](c1, c2 Config) bool
• func IsEqualVT[T vtcompare.EqualVT[T]](c1, c2 T) bool
• func MergeDebugVals(to DebugValues, from ...DebugValues)
• type Config
• type Constructor
• type DebugValues
• type Debuggable
• type Placeholder
  • func (m *Placeholder) CloneMessageVT() proto.Message
  • func (m *Placeholder) CloneVT() *Placeholder
  • func (*Placeholder) Descriptor() ([]byte, []int)
  • func (this *Placeholder) EqualMessageVT(thatMsg proto.Message) bool
  • func (this *Placeholder) EqualVT(that *Placeholder) bool
  • func (c *Placeholder) EqualsConfig(other Config) bool
  • func (c *Placeholder) GetConfigID() string
  • func (m *Placeholder) MarshalToSizedBufferVT(dAtA []byte) (int, error)
  • func (m *Placeholder) MarshalToVT(dAtA []byte) (int, error)
  • func (m *Placeholder) MarshalVT() (dAtA []byte, err error)
  • func (*Placeholder) ProtoMessage()
  • func (x *Placeholder) ProtoReflect() protoreflect.Message
  • func (x *Placeholder) Reset()
  • func (m *Placeholder) SizeVT() (n int)
  • func (x *Placeholder) String() string
  • func (m *Placeholder) UnmarshalVT(dAtA []byte) error
  • func (c *Placeholder) Validate() error

Variables

var File_github_com_aperturerobotics_controllerbus_config_config_proto protoreflect.FileDescriptor

Functions

func EqualsConfig

func EqualsConfig[T vtcompare.EqualVT[T]](c1, c2 Config) bool

EqualsConfig implements EqualsConfig assuming both Config are the same type and have VTEqual.

func IsEqualVT

func IsEqualVT[T vtcompare.EqualVT[T]](c1, c2 T) bool

IsEqualVT compares two objects with VTEqual.

func MergeDebugVals

func MergeDebugVals(to DebugValues, from ...DebugValues)

MergeDebugVals merges multiple DebugValues into the first DebugValues passed.

Types

type Config

type Config interface {
	proto.Message

	// Validate validates the configuration.
	// This is a cursory validation to see if the values "look correct."
	Validate() error
	// GetConfigID returns the unique string for this configuration type.
	// This string is stored with the encoded config.
	GetConfigID() string
	// EqualsConfig checks if the config is equal to another.
	EqualsConfig(other Config) bool

	// MarshalVT marshals the config object with vtprotobuf.
	MarshalVT() ([]byte, error)
	// UnmarshalVT unmarshals the config object with vtprotobuf.
	UnmarshalVT(data []byte) error
}

Config is an object specifying configuration for a component of the system.

type Constructor

type Constructor interface {
	// GetConfigID returns the unique string for this configuration type.
	GetConfigID() string
	// ConstructConfig constructs a new configuration object.
	ConstructConfig() Config
}

Constructor constructs configuration objects.

type DebugValues

type DebugValues map[string][]string

DebugValues maps string key to a list of values. It is used for debug visualizations.

type Debuggable

type Debuggable interface {
	// GetDebugVals returns the directive arguments as key/value pairs.
	// This should be something like param1="test", param2="test".
	// This is not necessarily unique, and is primarily intended for display.
	GetDebugVals() DebugValues
}

Debuggable is a configuration with debug values.

These debug values are sometimes combined with Exec or Load directives.

type Placeholder

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

Placeholder is a config used for type assertions.

func (*Placeholder) CloneMessageVT

func (m *Placeholder) CloneMessageVT() proto.Message

func (*Placeholder) CloneVT

func (m *Placeholder) CloneVT() *Placeholder

func (*Placeholder) Descriptor

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

Deprecated: Use Placeholder.ProtoReflect.Descriptor instead.

func (*Placeholder) EqualMessageVT

func (this *Placeholder) EqualMessageVT(thatMsg proto.Message) bool

func (*Placeholder) EqualVT

func (this *Placeholder) EqualVT(that *Placeholder) bool

func (*Placeholder) EqualsConfig

func (c *Placeholder) EqualsConfig(other Config) bool

EqualsConfig checks if the config is equal to another.

func (*Placeholder) GetConfigID

func (c *Placeholder) GetConfigID() string

GetConfigID returns the unique string for this configuration type.

func (*Placeholder) MarshalToSizedBufferVT

func (m *Placeholder) MarshalToSizedBufferVT(dAtA []byte) (int, error)

func (*Placeholder) MarshalToVT

func (m *Placeholder) MarshalToVT(dAtA []byte) (int, error)

func (*Placeholder) MarshalVT

func (m *Placeholder) MarshalVT() (dAtA []byte, err error)

func (*Placeholder) ProtoMessage

func (*Placeholder) ProtoMessage()

func (*Placeholder) ProtoReflect

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

func (*Placeholder) Reset

func (x *Placeholder) Reset()

func (*Placeholder) SizeVT

func (m *Placeholder) SizeVT() (n int)

func (*Placeholder) String

func (x *Placeholder) String() string

func (*Placeholder) UnmarshalVT

func (m *Placeholder) UnmarshalVT(dAtA []byte) error

func (*Placeholder) Validate

func (c *Placeholder) Validate() error

Validate validates the configuration. This is a cursory validation to see if the values "look correct."