Documentation ¶
Index ¶
- Variables
- type Boilerplate
- func (b *Boilerplate) BoilerplateMessage() string
- func (m *Boilerplate) CloneGenericVT() proto.Message
- func (m *Boilerplate) CloneVT() *Boilerplate
- func (*Boilerplate) Descriptor() ([]byte, []int)deprecated
- func (this *Boilerplate) EqualVT(that *Boilerplate) bool
- func (b *Boilerplate) GetDebugVals() directive.DebugValues
- func (x *Boilerplate) GetMessageText() string
- func (b *Boilerplate) GetName() string
- func (b *Boilerplate) GetNetworkedCodec() directive.NetworkedCodec
- func (b *Boilerplate) GetValueOptions() directive.ValueOptions
- func (b *Boilerplate) IsEquivalent(other directive.Directive) bool
- func (m *Boilerplate) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *Boilerplate) MarshalToVT(dAtA []byte) (int, error)
- func (m *Boilerplate) MarshalVT() (dAtA []byte, err error)
- func (*Boilerplate) ProtoMessage()
- func (x *Boilerplate) ProtoReflect() protoreflect.Message
- func (x *Boilerplate) Reset()
- func (m *Boilerplate) SizeVT() (n int)
- func (x *Boilerplate) String() string
- func (b *Boilerplate) Superceeds(other directive.Directive) bool
- func (m *Boilerplate) UnmarshalVT(dAtA []byte) error
- func (b *Boilerplate) Validate() error
- type BoilerplateResult
- func (m *BoilerplateResult) CloneGenericVT() proto.Message
- func (m *BoilerplateResult) CloneVT() *BoilerplateResult
- func (*BoilerplateResult) Descriptor() ([]byte, []int)deprecated
- func (this *BoilerplateResult) EqualVT(that *BoilerplateResult) bool
- func (x *BoilerplateResult) GetPrintedLen() uint32
- func (m *BoilerplateResult) MarshalToSizedBufferVT(dAtA []byte) (int, error)
- func (m *BoilerplateResult) MarshalToVT(dAtA []byte) (int, error)
- func (m *BoilerplateResult) MarshalVT() (dAtA []byte, err error)
- func (*BoilerplateResult) ProtoMessage()
- func (x *BoilerplateResult) ProtoReflect() protoreflect.Message
- func (x *BoilerplateResult) Reset()
- func (m *BoilerplateResult) SizeVT() (n int)
- func (x *BoilerplateResult) String() string
- func (m *BoilerplateResult) UnmarshalVT(dAtA []byte) error
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidLength = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflow = fmt.Errorf("proto: integer overflow") ErrUnexpectedEndOfGroup = fmt.Errorf("proto: unexpected end of group") )
var File_github_com_aperturerobotics_controllerbus_example_boilerplate_v1_boilerplate_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Boilerplate ¶
type Boilerplate struct { // MessageText is the message to print with the boilerplate. // This is an example field. // The keyword "message" prevents us from using that as the field name. MessageText string `protobuf:"bytes,1,opt,name=message_text,json=messageText,proto3" json:"message_text,omitempty"` // contains filtered or unexported fields }
Boilerplate implements the boilerplate directive.
func (*Boilerplate) BoilerplateMessage ¶
func (b *Boilerplate) BoilerplateMessage() string
BoilerplateMessage returns the message to print.
func (*Boilerplate) CloneGenericVT ¶ added in v0.12.3
func (m *Boilerplate) CloneGenericVT() proto.Message
func (*Boilerplate) CloneVT ¶ added in v0.12.3
func (m *Boilerplate) CloneVT() *Boilerplate
func (*Boilerplate) Descriptor
deprecated
func (*Boilerplate) Descriptor() ([]byte, []int)
Deprecated: Use Boilerplate.ProtoReflect.Descriptor instead.
func (*Boilerplate) EqualVT ¶ added in v0.10.0
func (this *Boilerplate) EqualVT(that *Boilerplate) bool
func (*Boilerplate) GetDebugVals ¶
func (b *Boilerplate) GetDebugVals() directive.DebugValues
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.
func (*Boilerplate) GetMessageText ¶
func (x *Boilerplate) GetMessageText() string
func (*Boilerplate) GetName ¶
func (b *Boilerplate) GetName() string
GetName returns the directive's type name. This is not necessarily unique, and is primarily intended for display.
func (*Boilerplate) GetNetworkedCodec ¶
func (b *Boilerplate) GetNetworkedCodec() directive.NetworkedCodec
GetNetworkedCodec returns the encoder / decoder for this directive.
func (*Boilerplate) GetValueOptions ¶
func (b *Boilerplate) GetValueOptions() directive.ValueOptions
GetValueOptions returns options relating to value handling.
func (*Boilerplate) IsEquivalent ¶
func (b *Boilerplate) IsEquivalent(other directive.Directive) bool
IsEquivalent checks if the other directive is equivalent. If two directives are equivalent, and the new directive does not superceed the old, then the new directive will be merged (de-duplicated) into the old.
func (*Boilerplate) MarshalToSizedBufferVT ¶ added in v0.10.0
func (m *Boilerplate) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*Boilerplate) MarshalToVT ¶ added in v0.10.0
func (m *Boilerplate) MarshalToVT(dAtA []byte) (int, error)
func (*Boilerplate) MarshalVT ¶ added in v0.10.0
func (m *Boilerplate) MarshalVT() (dAtA []byte, err error)
func (*Boilerplate) ProtoMessage ¶
func (*Boilerplate) ProtoMessage()
func (*Boilerplate) ProtoReflect ¶ added in v0.10.1
func (x *Boilerplate) ProtoReflect() protoreflect.Message
func (*Boilerplate) Reset ¶
func (x *Boilerplate) Reset()
func (*Boilerplate) SizeVT ¶ added in v0.10.0
func (m *Boilerplate) SizeVT() (n int)
func (*Boilerplate) String ¶
func (x *Boilerplate) String() string
func (*Boilerplate) Superceeds ¶
func (b *Boilerplate) Superceeds(other directive.Directive) bool
Superceeds checks if the directive overrides another. The other directive will be canceled if superceded.
func (*Boilerplate) UnmarshalVT ¶ added in v0.10.0
func (m *Boilerplate) UnmarshalVT(dAtA []byte) error
func (*Boilerplate) Validate ¶
func (b *Boilerplate) Validate() error
Validate validates the directive. This is a cursory validation to see if the values "look correct."
type BoilerplateResult ¶
type BoilerplateResult struct { // PrintedLen is the final length of the printed message. PrintedLen uint32 `protobuf:"varint,1,opt,name=printed_len,json=printedLen,proto3" json:"printed_len,omitempty"` // contains filtered or unexported fields }
BoilerplateResult implements the boilerplate directive result.
func (*BoilerplateResult) CloneGenericVT ¶ added in v0.12.3
func (m *BoilerplateResult) CloneGenericVT() proto.Message
func (*BoilerplateResult) CloneVT ¶ added in v0.12.3
func (m *BoilerplateResult) CloneVT() *BoilerplateResult
func (*BoilerplateResult) Descriptor
deprecated
func (*BoilerplateResult) Descriptor() ([]byte, []int)
Deprecated: Use BoilerplateResult.ProtoReflect.Descriptor instead.
func (*BoilerplateResult) EqualVT ¶ added in v0.10.0
func (this *BoilerplateResult) EqualVT(that *BoilerplateResult) bool
func (*BoilerplateResult) GetPrintedLen ¶
func (x *BoilerplateResult) GetPrintedLen() uint32
func (*BoilerplateResult) MarshalToSizedBufferVT ¶ added in v0.10.0
func (m *BoilerplateResult) MarshalToSizedBufferVT(dAtA []byte) (int, error)
func (*BoilerplateResult) MarshalToVT ¶ added in v0.10.0
func (m *BoilerplateResult) MarshalToVT(dAtA []byte) (int, error)
func (*BoilerplateResult) MarshalVT ¶ added in v0.10.0
func (m *BoilerplateResult) MarshalVT() (dAtA []byte, err error)
func (*BoilerplateResult) ProtoMessage ¶
func (*BoilerplateResult) ProtoMessage()
func (*BoilerplateResult) ProtoReflect ¶ added in v0.10.1
func (x *BoilerplateResult) ProtoReflect() protoreflect.Message
func (*BoilerplateResult) Reset ¶
func (x *BoilerplateResult) Reset()
func (*BoilerplateResult) SizeVT ¶ added in v0.10.0
func (m *BoilerplateResult) SizeVT() (n int)
func (*BoilerplateResult) String ¶
func (x *BoilerplateResult) String() string
func (*BoilerplateResult) UnmarshalVT ¶ added in v0.10.0
func (m *BoilerplateResult) UnmarshalVT(dAtA []byte) error