-
Notifications
You must be signed in to change notification settings - Fork 8
/
directive.go
86 lines (70 loc) · 2.45 KB
/
directive.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
package peer
import (
"github.com/aperturerobotics/controllerbus/directive"
)
// GetPeer is a directive to lookup a peer on a controller.
type GetPeer interface {
// Directive indicates GetPeer is a directive.
directive.Directive
// GetPeerIDConstraint returns a specific peer ID node we are looking for.
// If empty, any node is matched.
GetPeerIDConstraint() ID
}
// GetPeerValue is the result of the GetPeer directive.
type GetPeerValue = Peer
// getPeer implements GetPeer with a optional peer ID constraint.
type getPeer struct {
peerIDConstraint ID
}
// NewGetPeer constructs a new getPeer directive.
func NewGetPeer(peerID ID) GetPeer {
return &getPeer{peerIDConstraint: peerID}
}
// GetPeerIDConstraint returns a specific peer ID node we are looking for.
// If empty, any node is matched.
func (d *getPeer) GetPeerIDConstraint() ID {
return d.peerIDConstraint
}
// Validate validates the directive.
// This is a cursory validation to see if the values "look correct."
func (d *getPeer) Validate() error {
return nil
}
// GetValueOptions returns options relating to value handling.
func (d *getPeer) GetValueOptions() directive.ValueOptions {
return directive.ValueOptions{}
}
// 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 (d *getPeer) IsEquivalent(other directive.Directive) bool {
od, ok := other.(GetPeer)
if !ok {
return false
}
return d.peerIDConstraint == od.GetPeerIDConstraint()
}
// Superceeds checks if the directive overrides another.
// The other directive will be canceled if superceded.
func (d *getPeer) Superceeds(other directive.Directive) bool {
return false
}
// GetName returns the directive's type name.
// This is not necessarily unique, and is primarily intended for display.
func (d *getPeer) GetName() string {
return "GetPeer"
}
// GetDebugString returns the directive arguments stringified.
// This should be something like param1="test", param2="test".
// This is not necessarily unique, and is primarily intended for display.
func (d *getPeer) GetDebugVals() directive.DebugValues {
vals := directive.DebugValues{}
if pid := d.GetPeerIDConstraint(); pid != ID("") {
vals["peer-id"] = []string{pid.Pretty()}
}
return vals
}
// _ is a type constraint
var _ GetPeer = ((*getPeer)(nil))
// _ is a type constraint
var _ directive.Debuggable = ((*getPeer)(nil))