config

package

v0.17.0 Latest Latest Go to latest Published: Oct 14, 2022 License: Apache-2.0 Imports: 8 Imported by: 31

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/aperturerobotics/controllerbus

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrInvalidLength        = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflow          = fmt.Errorf("proto: integer overflow")
	ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group")
)

View Source

var File_github_com_aperturerobotics_controllerbus_config_placeholder_proto protoreflect.FileDescriptor

Functions ¶

This section is empty.

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.
	// Example: controllerbus/example/boilerplate/1
	GetConfigID() string
	// EqualsConfig checks if the config is equal to another.
	EqualsConfig(other Config) bool
}

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.
	// Example: controllerbus/example/boilerplate/1
	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 ¶ added in v0.15.1

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

Placeholder is a config used for type assertions.

func (*Placeholder) CloneGenericVT ¶ added in v0.15.1

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

func (*Placeholder) CloneVT ¶ added in v0.15.1

func (m *Placeholder) CloneVT() *Placeholder

func (*Placeholder) Descriptor deprecated added in v0.15.1

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

Deprecated: Use Placeholder.ProtoReflect.Descriptor instead.

func (*Placeholder) EqualVT ¶ added in v0.15.1

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

func (*Placeholder) EqualsConfig ¶ added in v0.15.1

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

EqualsConfig checks if the config is equal to another.

func (*Placeholder) GetConfigID ¶ added in v0.15.1

func (c *Placeholder) GetConfigID() string

GetConfigID returns the unique string for this configuration type.

func (*Placeholder) MarshalToSizedBufferVT ¶ added in v0.15.1

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

func (*Placeholder) MarshalToVT ¶ added in v0.15.1

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

func (*Placeholder) MarshalVT ¶ added in v0.15.1

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

func (*Placeholder) ProtoMessage ¶ added in v0.15.1

func (*Placeholder) ProtoMessage()

func (*Placeholder) ProtoReflect ¶ added in v0.15.1

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

func (*Placeholder) Reset ¶ added in v0.15.1

func (x *Placeholder) Reset()

func (*Placeholder) SizeVT ¶ added in v0.15.1

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

func (*Placeholder) String ¶ added in v0.15.1

func (x *Placeholder) String() string

func (*Placeholder) UnmarshalVT ¶ added in v0.15.1

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

func (*Placeholder) Validate ¶ added in v0.15.1

func (c *Placeholder) Validate() error

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

Source Files ¶

View all Source files

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