Documentation
¶
Index ¶
- Variables
- type Capability
- type CapabilitySet
- func (s CapabilitySet) Add(capability Capability) (CapabilitySet, error)
- func (s CapabilitySet) Clone() CapabilitySet
- func (s CapabilitySet) Contains(capability Capability) bool
- func (s CapabilitySet) Normalize() (CapabilitySet, error)
- func (s CapabilitySet) Sorted() CapabilitySet
- func (s CapabilitySet) Strings() []string
- type NameEmptyError
- type UnknownError
Constants ¶
This section is empty.
Variables ¶
var ( // ErrNameEmpty reports an empty capability name. ErrNameEmpty = errors.New("component manager capability name is empty") // ErrUnknown reports an unsupported capability name. ErrUnknown = errors.New("unknown component manager capability") )
Functions ¶
This section is empty.
Types ¶
type Capability ¶
type Capability string
Capability identifies an operation supported by a component manager implementation.
const ( CapabilityInjectExpectation Capability = "InjectExpectation" CapabilityPowerControl Capability = "PowerControl" CapabilityPowerStatus Capability = "PowerStatus" CapabilityFirmwareControl Capability = "FirmwareControl" CapabilityFirmwareStatus Capability = "FirmwareStatus" CapabilityBringUpControl Capability = "BringUpControl" CapabilityBringUpStatus Capability = "BringUpStatus" CapabilityFirmwareConsistencyCheck Capability = "FirmwareConsistencyCheck" )
func Parse ¶
func Parse(name string) (Capability, error)
Parse trims and validates a component manager capability name.
func (Capability) Valid ¶
func (c Capability) Valid() bool
Valid reports whether c is one of the known component manager capabilities.
type CapabilitySet ¶
type CapabilitySet []Capability
CapabilitySet is the normalized set of operations supported by a component manager implementation.
func NewSet ¶
func NewSet(capabilities ...Capability) (CapabilitySet, error)
NewSet returns capabilities trimmed, deduplicated, and sorted.
func (CapabilitySet) Add ¶
func (s CapabilitySet) Add(capability Capability) (CapabilitySet, error)
Add returns a capability set with capability included once. The receiver must already be normalized; use NewSet or Normalize to build a CapabilitySet from arbitrary input.
func (CapabilitySet) Clone ¶
func (s CapabilitySet) Clone() CapabilitySet
Clone returns a capability set copy that does not share storage with the source set.
func (CapabilitySet) Contains ¶
func (s CapabilitySet) Contains(capability Capability) bool
Contains reports whether s includes capability.
func (CapabilitySet) Normalize ¶
func (s CapabilitySet) Normalize() (CapabilitySet, error)
Normalize returns capabilities trimmed, deduplicated, and sorted.
func (CapabilitySet) Sorted ¶
func (s CapabilitySet) Sorted() CapabilitySet
Sorted returns a sorted copy of s.
func (CapabilitySet) Strings ¶
func (s CapabilitySet) Strings() []string
Strings returns the capability names as strings.
type NameEmptyError ¶
type NameEmptyError struct{}
NameEmptyError reports an empty capability name in descriptor metadata.
func (NameEmptyError) Error ¶
func (e NameEmptyError) Error() string
func (NameEmptyError) Is ¶
func (e NameEmptyError) Is(target error) bool
type UnknownError ¶
type UnknownError struct {
Capability Capability
}
UnknownError includes the unsupported capability name.
func (UnknownError) Error ¶
func (e UnknownError) Error() string
func (UnknownError) Is ¶
func (e UnknownError) Is(target error) bool
Source Files