Documentation
¶
Overview ¶
Package message provides utilities for representing information about Dogma messages and their use within an application.
Index ¶
- Variables
- type Name
- type NameCollection
- type NameRoles
- func (nr NameRoles) Add(n Name, r Role) bool
- func (nr NameRoles) AddM(m dogma.Message, r Role) bool
- func (nr NameRoles) Each(fn func(Name) bool) bool
- func (nr NameRoles) Has(n Name) bool
- func (nr NameRoles) HasM(m dogma.Message) bool
- func (nr NameRoles) Remove(n Name) bool
- func (nr NameRoles) RemoveM(m dogma.Message) bool
- type NameSet
- type Role
- func (r Role) Is(roles ...Role) bool
- func (r Role) Marker() string
- func (r Role) MarshalBinary() ([]byte, error)
- func (r Role) MarshalText() ([]byte, error)
- func (r Role) MustBe(roles ...Role)
- func (r Role) MustNotBe(roles ...Role)
- func (r Role) MustValidate()
- func (r Role) ShortString() string
- func (r Role) String() string
- func (r *Role) UnmarshalBinary(data []byte) error
- func (r *Role) UnmarshalText(text []byte) error
- func (r Role) Validate() error
- type Type
- type TypeCollection
- type TypeRoles
- func (tr TypeRoles) Add(t Type, r Role) bool
- func (tr TypeRoles) AddM(m dogma.Message, r Role) bool
- func (tr TypeRoles) Each(fn func(Type) bool) bool
- func (tr TypeRoles) Has(t Type) bool
- func (tr TypeRoles) HasM(m dogma.Message) bool
- func (tr TypeRoles) Remove(t Type) bool
- func (tr TypeRoles) RemoveM(m dogma.Message) bool
- type TypeSet
Constants ¶
This section is empty.
Variables ¶
var Roles = []Role{ CommandRole, EventRole, TimeoutRole, }
Roles is a slice of the valid message roles.
Functions ¶
This section is empty.
Types ¶
type Name ¶
type Name struct {
// contains filtered or unexported fields
}
Name is the fully-qualified name of a message type.
func (Name) MarshalBinary ¶
MarshalBinary returns a binary representation of the name.
func (Name) MarshalText ¶
MarshalText returns a UTF-8 representation of the name.
func (*Name) UnmarshalBinary ¶
UnmarshalBinary unmarshals a type from its binary representation.
func (*Name) UnmarshalText ¶
UnmarshalText unmarshals a name from its UTF-8 representation.
type NameCollection ¶
type NameCollection interface {
// Has returns true if n is in the container.
Has(n Name) bool
// HasM returns true if NameOf(m) is in the container.
HasM(m dogma.Message) bool
// Each invokes fn once for each name in the container.
//
// Iteration stops when fn returns false or once fn has been invoked for all
// names in the container.
//
// It returns true if fn returned true for all names.
Each(fn func(Name) bool) bool
}
NameCollection is an interface for containers of message names.
type NameRoles ¶
NameRoles is an implementation of NameCollection that maps message types to their roles.
func (NameRoles) Add ¶
Add maps n to r.
It returns true if the mapping was added, or false if the map already contained the name.
func (NameRoles) AddM ¶
AddM adds NameOf(m) to nr.
It returns true if the mapping was added, or false if the map already contained the name.
func (NameRoles) Each ¶
Each invokes fn once for each name in the container.
Iteration stops when fn returns false or once fn has been invoked for all types in the container.
It returns true if fn returned true for all types.
type NameSet ¶
type NameSet map[Name]struct{}
NameSet is an implementation of NameCollection that contains a distinct set of message names.
func NewNameSet ¶
NewNameSet returns a NameSet containing the given names.
func (NameSet) Add ¶
Add adds n to s.
It returns true if the name was added, or false if the set already contained the name.
func (NameSet) AddM ¶
AddM adds NameOf(m) to s.
It returns true if the name was added, or false if the set already contained the name.
func (NameSet) Each ¶
Each invokes fn once for each name in the container.
Iteration stops when fn returns false or once fn has been invoked for all names in the container.
It returns true if fn returned true for all names.
type Role ¶
type Role string
Role is an enumeration of the roles a message can perform within an application.
func (Role) Marker ¶
Marker returns a character that identifies the message role when displaying message types.
func (Role) MarshalBinary ¶
MarshalBinary returns a binary representation of the message role.
func (Role) MarshalText ¶
MarshalText returns a UTF-8 representation of the message role.
func (Role) MustValidate ¶
func (r Role) MustValidate()
MustValidate panics if r is not a valid message role.
func (Role) ShortString ¶
ShortString returns a short (3-character) representation of the handler type.
func (*Role) UnmarshalBinary ¶
UnmarshalBinary unmarshals a role from its binary representation.
func (*Role) UnmarshalText ¶
UnmarshalText unmarshals a role from its UTF-8 representation.
type Type ¶
type Type struct {
// contains filtered or unexported fields
}
Type represents the type of a Dogma message.
func (Type) Name ¶
Name returns the fully-qualified name for the Go type.
It panics if t.IsZero() returns true.
func (Type) ReflectType ¶
ReflectType returns the reflect.Type of the message.
It panics if t.IsZero() returns true.
type TypeCollection ¶
type TypeCollection interface {
// Has returns true if t is in the container.
Has(t Type) bool
// HasM returns true if TypeOf(m) is in the container.
HasM(m dogma.Message) bool
// Each invokes fn once for each type in the container.
//
// Iteration stops when fn returns false or once fn has been invoked for all
// types in the container.
//
// It returns true if fn returned true for all types.
Each(fn func(Type) bool) bool
}
TypeCollection is an interface for containers of message types.
type TypeRoles ¶
TypeRoles is an implementation of TypeCollection that maps message types to their roles.
func (TypeRoles) Add ¶
Add maps t to r.
It returns true if the mapping was added, or false if the map already contained the type.
func (TypeRoles) AddM ¶
AddM adds TypeOf(m) to tr.
It returns true if the mapping was added, or false if the map already contained the type.
func (TypeRoles) Each ¶
Each invokes fn once for each type in the container.
Iteration stops when fn returns false or once fn has been invoked for all types in the container.
It returns true if fn returned true for all types.
type TypeSet ¶
type TypeSet map[Type]struct{}
TypeSet is an implementation of TypeCollection that contains a distinct set of message types.
func NewTypeSet ¶
NewTypeSet returns a TypeSet containing the given types.
func (TypeSet) Add ¶
Add adds t to s.
It returns true if the type was added, or false if the set already contained the type.
func (TypeSet) AddM ¶
AddM adds TypeOf(m) to s.
It returns true if the type was added, or false if the set already contained the type.
func (TypeSet) Each ¶
Each invokes fn once for each type in the container.
Iteration stops when fn returns false or once fn has been invoked for all types in the container.
It returns true if fn returned true for all types.
Source Files