boilerplate_v1

Documentation

Index

• type Boilerplate
  • func (b *Boilerplate) BoilerplateMessage() string
  • func (*Boilerplate) Descriptor() ([]byte, []int)
  • func (b *Boilerplate) GetDebugVals() directive.DebugValues
  • func (m *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 (*Boilerplate) ProtoMessage()
  • func (m *Boilerplate) Reset()
  • func (m *Boilerplate) String() string
  • func (b *Boilerplate) Superceeds(other directive.Directive) bool
  • func (b *Boilerplate) Validate() error
  • func (m *Boilerplate) XXX_DiscardUnknown()
  • func (m *Boilerplate) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *Boilerplate) XXX_Merge(src proto.Message)
  • func (m *Boilerplate) XXX_Size() int
  • func (m *Boilerplate) XXX_Unmarshal(b []byte) error
• type BoilerplateResult
  • func (*BoilerplateResult) Descriptor() ([]byte, []int)
  • func (m *BoilerplateResult) GetPrintedLen() uint32
  • func (*BoilerplateResult) ProtoMessage()
  • func (m *BoilerplateResult) Reset()
  • func (m *BoilerplateResult) String() string
  • func (m *BoilerplateResult) XXX_DiscardUnknown()
  • func (m *BoilerplateResult) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *BoilerplateResult) XXX_Merge(src proto.Message)
  • func (m *BoilerplateResult) XXX_Size() int
  • func (m *BoilerplateResult) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

Boilerplate implements the boilerplate directive.

func (*Boilerplate) BoilerplateMessage

func (b *Boilerplate) BoilerplateMessage() string

BoilerplateMessage returns the message to print.

func (*Boilerplate) Descriptor

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

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 (m *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) ProtoMessage

func (*Boilerplate) ProtoMessage()

func (*Boilerplate) Reset

func (m *Boilerplate) Reset()

func (*Boilerplate) String

func (m *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) Validate

func (b *Boilerplate) Validate() error

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

func (*Boilerplate) XXX_DiscardUnknown

func (m *Boilerplate) XXX_DiscardUnknown()

func (*Boilerplate) XXX_Marshal

func (m *Boilerplate) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Boilerplate) XXX_Merge

func (m *Boilerplate) XXX_Merge(src proto.Message)

func (*Boilerplate) XXX_Size

func (m *Boilerplate) XXX_Size() int

func (*Boilerplate) XXX_Unmarshal

func (m *Boilerplate) XXX_Unmarshal(b []byte) error

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"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

BoilerplateResult implements the boilerplate directive result.

func (*BoilerplateResult) Descriptor

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

func (*BoilerplateResult) GetPrintedLen

func (m *BoilerplateResult) GetPrintedLen() uint32

func (*BoilerplateResult) ProtoMessage

func (*BoilerplateResult) ProtoMessage()

func (*BoilerplateResult) Reset

func (m *BoilerplateResult) Reset()

func (*BoilerplateResult) String

func (m *BoilerplateResult) String() string

func (*BoilerplateResult) XXX_DiscardUnknown

func (m *BoilerplateResult) XXX_DiscardUnknown()

func (*BoilerplateResult) XXX_Marshal

func (m *BoilerplateResult) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*BoilerplateResult) XXX_Merge

func (m *BoilerplateResult) XXX_Merge(src proto.Message)

func (*BoilerplateResult) XXX_Size

func (m *BoilerplateResult) XXX_Size() int

func (*BoilerplateResult) XXX_Unmarshal

func (m *BoilerplateResult) XXX_Unmarshal(b []byte) error