label
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
Stable versionWhen a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Report a Vulnerability
Open Source Insights
Documentation¶
Index¶
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeKey¶
type Key interface {// Name returns the key name.Name()string// Description returns a string that can be used to describe the value.Description()string// Format is used in formatting to append the value of the label to the// supplied buffer.// The formatter may use the supplied buf as a scratch area to avoid// allocations.Format(wio.Writer, buf []byte, lLabel)}Key is used as the identity of a Label.Keys are intended to be compared by pointer only, the name should be uniquefor communicating with external systems, but it is not required or enforced.
typeLabel¶
type Label struct {// contains filtered or unexported fields}Label holds a key and value pair.It is normally used when passing around lists of labels.
funcOf64¶
Of64 creates a new label from a key and a uint64. This is oftenused for non uint64 values that can be packed into a uint64.This method is for implementing new key types, label creation shouldnormally be done with the Of method of the key.
funcOfString¶
OfString creates a new label from a key and a string.This method is for implementing new key types, label creation shouldnormally be done with the Of method of the key.
funcOfValue¶
OfValue creates a new label from the key and value.This method is for implementing new key types, label creation shouldnormally be done with the Of method of the key.
func (Label)Unpack64¶
Unpack64 assumes the label was built using LabelOf64 and returns the value thatwas passed to that constructor.This method is for implementing new key types, for type safety normalaccess should be done with the From method of the key.
func (Label)UnpackString¶
UnpackString assumes the label was built using LabelOfString and returns thevalue that was passed to that constructor.This method is for implementing new key types, for type safety normalaccess should be done with the From method of the key.
func (Label)UnpackValue¶
UnpackValue assumes the label was built using LabelOfValue and returns the valuethat was passed to that constructor.This method is for implementing new key types, for type safety normalaccess should be done with the From method of the key.
typeList¶
type List interface {// Valid returns true if the index is within range for the list.// It does not imply the label at that index will itself be valid.Valid(indexint)bool// Label returns the label at the given index.Label(indexint)Label}List is the interface to something that provides an iterablelist of labels.Iteration should start from 0 and continue until Valid returns false.
Source Files