Documentation ¶
Index ¶
- Constants
- func FmtHumanSize(size float64, suffix string, binary bool) string
- type ACLPrincipalFlag
- type ByteSizeFlag
- type CompletionMap
- type EnabledFlag
- type GetPropertiesFlag
- func (f *GetPropertiesFlag) Complete(match string) (comps []flags.Completion)
- func (f *GetPropertiesFlag) GettableKeys(keys ...string)
- func (f *GetPropertiesFlag) IsGettable(key string) bool
- func (f *GetPropertiesFlag) SetCompletions(comps CompletionMap)
- func (f *GetPropertiesFlag) UnmarshalFlag(fv string) error
- type HostSetFlag
- type LabelOrUUIDFlag
- func (f *LabelOrUUIDFlag) Clear()
- func (f LabelOrUUIDFlag) Empty() bool
- func (f LabelOrUUIDFlag) HasLabel() bool
- func (f LabelOrUUIDFlag) HasUUID() bool
- func (f *LabelOrUUIDFlag) SetLabel(l string) error
- func (f LabelOrUUIDFlag) String() string
- func (f *LabelOrUUIDFlag) UnmarshalFlag(fv string) error
- type MemberStateSetFlag
- type PropertiesFlag
- type RankSetFlag
- type SetPropertiesFlag
- func (f *SetPropertiesFlag) Complete(match string) (comps []flags.Completion)
- func (f *SetPropertiesFlag) IsSettable(key string) bool
- func (f *SetPropertiesFlag) SetCompletions(comps CompletionMap)
- func (f *SetPropertiesFlag) SettableKeys(keys ...string)
- func (f *SetPropertiesFlag) UnmarshalFlag(fv string) error
Constants ¶
const ( // MaxPropKeyLen is the maximum length of a property key. MaxPropKeyLen = daos.MaxAttributeNameLength )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ACLPrincipalFlag ¶
type ACLPrincipalFlag string
ACLPrincipalFlag is a flag that represents a DAOS ACL principal.
func (ACLPrincipalFlag) String ¶
func (p ACLPrincipalFlag) String() string
func (*ACLPrincipalFlag) UnmarshalFlag ¶
func (p *ACLPrincipalFlag) UnmarshalFlag(fv string) error
UnmarshalFlag implements the go-flags.Unmarshaler interface.
type ByteSizeFlag ¶
type ByteSizeFlag struct { Bytes uint64 // contains filtered or unexported fields }
ByteSizeFlag is a go-flags compatible flag type for converting string input into a byte size.
func (ByteSizeFlag) IsSet ¶
func (sf ByteSizeFlag) IsSet() bool
func (ByteSizeFlag) String ¶
func (sf ByteSizeFlag) String() string
func (*ByteSizeFlag) UnmarshalFlag ¶
func (sf *ByteSizeFlag) UnmarshalFlag(fv string) (err error)
type CompletionMap ¶
CompletionMap is a map of key to a list of possible completions.
type EnabledFlag ¶
EnabledFlag allows a flag to be optionally set to a boolean value.
func (*EnabledFlag) UnmarshalFlag ¶
func (f *EnabledFlag) UnmarshalFlag(fv string) error
UnmarshalFlag implements the flags.Unmarshaler interface.
type GetPropertiesFlag ¶
type GetPropertiesFlag struct { PropertiesFlag ParsedProps common.StringSet // contains filtered or unexported fields }
GetPropertiesFlag is used to hold a list of property keys to get.
func (*GetPropertiesFlag) Complete ¶
func (f *GetPropertiesFlag) Complete(match string) (comps []flags.Completion)
Complete implements the go-flags.Completer interface and is used to suggest possible completions for the supplied input string.
func (*GetPropertiesFlag) GettableKeys ¶
func (f *GetPropertiesFlag) GettableKeys(keys ...string)
GettableKeys accepts a list of property keys that are gettable.
func (*GetPropertiesFlag) IsGettable ¶
func (f *GetPropertiesFlag) IsGettable(key string) bool
IsGettable returns true if the key is in the list of gettable keys.
func (*GetPropertiesFlag) SetCompletions ¶
func (f *GetPropertiesFlag) SetCompletions(comps CompletionMap)
SetCompletions sets the possible completions for the GetPropertiesFlag.
func (*GetPropertiesFlag) UnmarshalFlag ¶
func (f *GetPropertiesFlag) UnmarshalFlag(fv string) error
UnmarshalFlag implements the go-flags.Unmarshaler interface and is used to parse the user-supplied list of properties to get.
type HostSetFlag ¶
HostSetFlag is a go-flags compatible flag type for handling inputs that can be converted to a hostlist.HostSet.
func (*HostSetFlag) Empty ¶
func (f *HostSetFlag) Empty() bool
Empty returns true if the flag was not set.
func (*HostSetFlag) MarshalJSON ¶
func (f *HostSetFlag) MarshalJSON() ([]byte, error)
MarshalFlag implements the go-flags.Marshaler interface.
func (*HostSetFlag) UnmarshalFlag ¶
func (f *HostSetFlag) UnmarshalFlag(fv string) error
UnmarshalFlag implements the go-flags.Unmarshaler interface.
type LabelOrUUIDFlag ¶
LabelOrUUIDFlag is used to hold a pool or container ID supplied via command-line argument.
func (*LabelOrUUIDFlag) Clear ¶
func (f *LabelOrUUIDFlag) Clear()
Clear resets the flag to its zero value.
func (LabelOrUUIDFlag) Empty ¶
func (f LabelOrUUIDFlag) Empty() bool
Empty returns true if neither UUID or Label were set.
func (LabelOrUUIDFlag) HasLabel ¶
func (f LabelOrUUIDFlag) HasLabel() bool
HasLabel returns true if Label is a nonempty string.
func (LabelOrUUIDFlag) HasUUID ¶
func (f LabelOrUUIDFlag) HasUUID() bool
HasUUID returns true if UUID is a nonzero value.
func (*LabelOrUUIDFlag) SetLabel ¶
func (f *LabelOrUUIDFlag) SetLabel(l string) error
SetLabel validates the supplied label and sets it if valid.
func (LabelOrUUIDFlag) String ¶
func (f LabelOrUUIDFlag) String() string
func (*LabelOrUUIDFlag) UnmarshalFlag ¶
func (f *LabelOrUUIDFlag) UnmarshalFlag(fv string) error
UnmarshalFlag implements the go-flags.Unmarshaler interface.
type MemberStateSetFlag ¶
type MemberStateSetFlag struct {
States system.MemberState
}
MemberStateSetFlag is a go-flags compatible flag type for handling inputs that can be converted to a system.MemberState slice.
func (*MemberStateSetFlag) Complete ¶
func (f *MemberStateSetFlag) Complete(match string) (comps []flags.Completion)
Complete implements the go-flags.Completer interface and is used to suggest possible completions for the supplied input string. Handle multiple member state,... completions.
func (*MemberStateSetFlag) Empty ¶
func (f *MemberStateSetFlag) Empty() bool
Empty returns true if the flag was not set.
func (*MemberStateSetFlag) UnmarshalFlag ¶
func (f *MemberStateSetFlag) UnmarshalFlag(fv string) error
UnmarshalFlag implements the go-flags.Unmarshaler interface.
type PropertiesFlag ¶
type PropertiesFlag struct {
// contains filtered or unexported fields
}
func (*PropertiesFlag) DeprecatedKeyMap ¶
func (f *PropertiesFlag) DeprecatedKeyMap(deprKeyMap map[string]string)
SettableDeprecated Keys accepts a list of deprecated property keys that are settable.
type RankSetFlag ¶
RankSetFlag is a go-flags compatible flag type for handling inputs that can be converted to a system.RankSet.
func (RankSetFlag) Empty ¶
func (f RankSetFlag) Empty() bool
Empty returns true if the flag was not set.
func (*RankSetFlag) MarshalJSON ¶
func (f *RankSetFlag) MarshalJSON() ([]byte, error)
func (*RankSetFlag) UnmarshalFlag ¶
func (f *RankSetFlag) UnmarshalFlag(fv string) error
UnmarshalFlag implements the go-flags.Unmarshaler interface.
type SetPropertiesFlag ¶
type SetPropertiesFlag struct { PropertiesFlag ParsedProps map[string]string // contains filtered or unexported fields }
SetPropertiesFlag is used to hold a list of properties to set.
func (*SetPropertiesFlag) Complete ¶
func (f *SetPropertiesFlag) Complete(match string) (comps []flags.Completion)
Complete implements the go-flags.Completer interface and is used to suggest possible completions for the supplied input string.
func (*SetPropertiesFlag) IsSettable ¶
func (f *SetPropertiesFlag) IsSettable(key string) bool
IsSettable returns true if the key is in the list of settable keys.
func (*SetPropertiesFlag) SetCompletions ¶
func (f *SetPropertiesFlag) SetCompletions(comps CompletionMap)
SetCompletions sets the possible completions for the SetPropertiesFlag.
func (*SetPropertiesFlag) SettableKeys ¶
func (f *SetPropertiesFlag) SettableKeys(keys ...string)
SettableKeys accepts a list of property keys that are settable.
func (*SetPropertiesFlag) UnmarshalFlag ¶
func (f *SetPropertiesFlag) UnmarshalFlag(fv string) error
UnmarshalFlag implements the go-flags.Unmarshaler interface and is used to parse the user-supplied properties.