package label

Import Path
	golang.org/x/tools/internal/event/label (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 3 packages

Involved Source Files

	      label.go
Package-Level Type Names (total 9, in which 4 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Key (interface)
		Key is used as the identity of a Label.
		Keys are intended to be compared by pointer only, the name should be unique
		for communicating with external systems, but it is not required or enforced.

		Methods (total 3, all are exported)
			( Key) Description() string
				Description returns a string that can be used to describe the value.

			( Key) Format(w io.Writer, buf []byte, l Label)
				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.

			( Key) Name() string
				Name returns the key name.

		Implemented By (at least 17, all are exported)
			*golang.org/x/tools/internal/event/keys.Boolean
			*golang.org/x/tools/internal/event/keys.Error
			*golang.org/x/tools/internal/event/keys.Float32
			*golang.org/x/tools/internal/event/keys.Float64
			*golang.org/x/tools/internal/event/keys.Int
			*golang.org/x/tools/internal/event/keys.Int16
			*golang.org/x/tools/internal/event/keys.Int32
			*golang.org/x/tools/internal/event/keys.Int64
			*golang.org/x/tools/internal/event/keys.Int8
			*golang.org/x/tools/internal/event/keys.String
			*golang.org/x/tools/internal/event/keys.Tag
			*golang.org/x/tools/internal/event/keys.UInt
			*golang.org/x/tools/internal/event/keys.UInt16
			*golang.org/x/tools/internal/event/keys.UInt32
			*golang.org/x/tools/internal/event/keys.UInt64
			*golang.org/x/tools/internal/event/keys.UInt8
			*golang.org/x/tools/internal/event/keys.Value
		As Outputs Of (at least one exported)
			func Label.Key() Key
		As Inputs Of (at least 6, all are exported)
			func Filter(l List, keys ...Key) List
			func Of64(k Key, v uint64) Label
			func OfString(k Key, v string) Label
			func OfValue(k Key, value interface{}) Label
			func Map.Find(key Key) Label
			func golang.org/x/tools/internal/event/core.Event.Find(key Key) Label

	 type Label (struct)
		Label holds a key and value pair.
		It is normally used when passing around lists of labels.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			key Key
			packed uint64
			untyped interface{}
		Methods (total 6, all are exported)
			( Label) Format(f fmt.State, r rune)
				Format is used for debug printing of labels.

			( Label) Key() Key
				Key returns the key of this Label.

			( Label) Unpack64() uint64
				Unpack64 assumes the label was built using LabelOf64 and returns the value that
				was passed to that constructor.
				This method is for implementing new key types, for type safety normal
				access should be done with the From method of the key.

			( Label) UnpackString() string
				UnpackString assumes the label was built using LabelOfString and returns the
				value that was passed to that constructor.
				This method is for implementing new key types, for type safety normal
				access should be done with the From method of the key.

			( Label) UnpackValue() interface{}
				UnpackValue assumes the label was built using LabelOfValue and returns the value
				that was passed to that constructor.
				This method is for implementing new key types, for type safety normal
				access should be done with the From method of the key.

			( Label) Valid() bool
				Valid returns true if the Label is a valid one (it has a key).

		Implements (at least one exported)
			 Label : fmt.Formatter
		As Outputs Of (at least 24, all are exported)
			func Of64(k Key, v uint64) Label
			func OfString(k Key, v string) Label
			func OfValue(k Key, value interface{}) Label
			func List.Label(index int) Label
			func Map.Find(key Key) Label
			func golang.org/x/tools/internal/event/core.Event.Find(key Key) Label
			func golang.org/x/tools/internal/event/core.Event.Label(index int) Label
			func golang.org/x/tools/internal/event/keys.(*Boolean).Of(v bool) Label
			func golang.org/x/tools/internal/event/keys.(*Error).Of(v error) Label
			func golang.org/x/tools/internal/event/keys.(*Float32).Of(v float32) Label
			func golang.org/x/tools/internal/event/keys.(*Float64).Of(v float64) Label
			func golang.org/x/tools/internal/event/keys.(*Int).Of(v int) Label
			func golang.org/x/tools/internal/event/keys.(*Int16).Of(v int16) Label
			func golang.org/x/tools/internal/event/keys.(*Int32).Of(v int32) Label
			func golang.org/x/tools/internal/event/keys.(*Int64).Of(v int64) Label
			func golang.org/x/tools/internal/event/keys.(*Int8).Of(v int8) Label
			func golang.org/x/tools/internal/event/keys.(*String).Of(v string) Label
			func golang.org/x/tools/internal/event/keys.(*Tag).New() Label
			func golang.org/x/tools/internal/event/keys.(*UInt).Of(v uint) Label
			func golang.org/x/tools/internal/event/keys.(*UInt16).Of(v uint16) Label
			func golang.org/x/tools/internal/event/keys.(*UInt32).Of(v uint32) Label
			func golang.org/x/tools/internal/event/keys.(*UInt64).Of(v uint64) Label
			func golang.org/x/tools/internal/event/keys.(*UInt8).Of(v uint8) Label
			func golang.org/x/tools/internal/event/keys.(*Value).Of(value interface{}) Label
		As Inputs Of (at least 50, all are exported)
			func NewList(labels ...Label) List
			func NewMap(labels ...Label) Map
			func Key.Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event.Error(ctx context.Context, message string, err error, labels ...Label)
			func golang.org/x/tools/internal/event.Label(ctx context.Context, labels ...Label) context.Context
			func golang.org/x/tools/internal/event.Log(ctx context.Context, message string, labels ...Label)
			func golang.org/x/tools/internal/event.Metric(ctx context.Context, labels ...Label)
			func golang.org/x/tools/internal/event.Start(ctx context.Context, name string, labels ...Label) (context.Context, func())
			func golang.org/x/tools/internal/event/core.Log1(ctx context.Context, message string, t1 Label)
			func golang.org/x/tools/internal/event/core.Log2(ctx context.Context, message string, t1 Label, t2 Label)
			func golang.org/x/tools/internal/event/core.Log2(ctx context.Context, message string, t1 Label, t2 Label)
			func golang.org/x/tools/internal/event/core.MakeEvent(static [3]Label, labels []Label) core.Event
			func golang.org/x/tools/internal/event/core.MakeEvent(static [3]Label, labels []Label) core.Event
			func golang.org/x/tools/internal/event/core.Metric1(ctx context.Context, t1 Label) context.Context
			func golang.org/x/tools/internal/event/core.Metric2(ctx context.Context, t1, t2 Label) context.Context
			func golang.org/x/tools/internal/event/core.Start1(ctx context.Context, name string, t1 Label) (context.Context, func())
			func golang.org/x/tools/internal/event/core.Start2(ctx context.Context, name string, t1, t2 Label) (context.Context, func())
			func golang.org/x/tools/internal/event/keys.(*Boolean).Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event/keys.(*Boolean).From(t Label) bool
			func golang.org/x/tools/internal/event/keys.(*Error).Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event/keys.(*Error).From(t Label) error
			func golang.org/x/tools/internal/event/keys.(*Float32).Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event/keys.(*Float32).From(t Label) float32
			func golang.org/x/tools/internal/event/keys.(*Float64).Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event/keys.(*Float64).From(t Label) float64
			func golang.org/x/tools/internal/event/keys.(*Int).Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event/keys.(*Int).From(t Label) int
			func golang.org/x/tools/internal/event/keys.(*Int16).Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event/keys.(*Int16).From(t Label) int16
			func golang.org/x/tools/internal/event/keys.(*Int32).Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event/keys.(*Int32).From(t Label) int32
			func golang.org/x/tools/internal/event/keys.(*Int64).Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event/keys.(*Int64).From(t Label) int64
			func golang.org/x/tools/internal/event/keys.(*Int8).Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event/keys.(*Int8).From(t Label) int8
			func golang.org/x/tools/internal/event/keys.(*String).Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event/keys.(*String).From(t Label) string
			func golang.org/x/tools/internal/event/keys.(*Tag).Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event/keys.(*UInt).Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event/keys.(*UInt).From(t Label) uint
			func golang.org/x/tools/internal/event/keys.(*UInt16).Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event/keys.(*UInt16).From(t Label) uint16
			func golang.org/x/tools/internal/event/keys.(*UInt32).Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event/keys.(*UInt32).From(t Label) uint32
			func golang.org/x/tools/internal/event/keys.(*UInt64).Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event/keys.(*UInt64).From(t Label) uint64
			func golang.org/x/tools/internal/event/keys.(*UInt8).Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event/keys.(*UInt8).From(t Label) uint8
			func golang.org/x/tools/internal/event/keys.(*Value).Format(w io.Writer, buf []byte, l Label)
			func golang.org/x/tools/internal/event/keys.(*Value).From(t Label) interface{}

	 type List (interface)
		List is the interface to something that provides an iterable
		list of labels.
		Iteration should start from 0 and continue until Valid returns false.

		Methods (total 2, both are exported)
			( List) Label(index int) Label
				Label returns the label at the given index.

			( List) Valid(index int) bool
				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.

		Implemented By (at least 3, in which 1 are exported)
			 golang.org/x/tools/internal/event/core.Event
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*filter
			*list
		As Outputs Of (at least 2, both are exported)
			func Filter(l List, keys ...Key) List
			func NewList(labels ...Label) List
		As Inputs Of (at least one exported)
			func Filter(l List, keys ...Key) List

	 type Map (interface)
		Map is the interface to a collection of Labels indexed by key.

		Methods (only one, which is exported)
			( Map) Find(key Key) Label
				Find returns the label that matches the supplied key.

		Implemented By (at least 3, in which 1 are exported)
			 golang.org/x/tools/internal/event/core.Event
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 listMap
			 mapChain
		As Outputs Of (at least 2, both are exported)
			func MergeMaps(srcs ...Map) Map
			func NewMap(labels ...Label) Map
		As Inputs Of (at least 17, all are exported)
			func MergeMaps(srcs ...Map) Map
			func golang.org/x/tools/internal/event/keys.(*Boolean).Get(lm Map) bool
			func golang.org/x/tools/internal/event/keys.(*Error).Get(lm Map) error
			func golang.org/x/tools/internal/event/keys.(*Float32).Get(lm Map) float32
			func golang.org/x/tools/internal/event/keys.(*Float64).Get(lm Map) float64
			func golang.org/x/tools/internal/event/keys.(*Int).Get(lm Map) int
			func golang.org/x/tools/internal/event/keys.(*Int16).Get(lm Map) int16
			func golang.org/x/tools/internal/event/keys.(*Int32).Get(lm Map) int32
			func golang.org/x/tools/internal/event/keys.(*Int64).Get(lm Map) int64
			func golang.org/x/tools/internal/event/keys.(*Int8).Get(lm Map) int8
			func golang.org/x/tools/internal/event/keys.(*String).Get(lm Map) string
			func golang.org/x/tools/internal/event/keys.(*UInt).Get(lm Map) uint
			func golang.org/x/tools/internal/event/keys.(*UInt16).Get(lm Map) uint16
			func golang.org/x/tools/internal/event/keys.(*UInt32).Get(lm Map) uint32
			func golang.org/x/tools/internal/event/keys.(*UInt64).Get(lm Map) uint64
			func golang.org/x/tools/internal/event/keys.(*UInt8).Get(lm Map) uint8
			func golang.org/x/tools/internal/event/keys.(*Value).Get(lm Map) interface{}

	/* 5 unexporteds ... *//* 5 unexporteds: */
	 type filter (struct)
		filter wraps a LabelList filtering out specific labels.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			keys []Key
			underlying List
		Methods (total 2, both are exported)
			(*filter) Label(index int) Label
			(*filter) Valid(index int) bool
		Implements (at least one exported)
			*filter : List

	 type list (struct)
		list implements LabelList for a list of Labels.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			labels []Label
		Methods (total 2, both are exported)
			(*list) Label(index int) Label
			(*list) Valid(index int) bool
		Implements (at least one exported)
			*list : List
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var emptyList *list

	 type listMap (struct)
		listMap implements LabelMap for a simple list of labels.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			labels []Label
		Methods (only one, which is exported)
			( listMap) Find(key Key) Label
		Implements (at least one exported)
			 listMap : Map

	 type mapChain (struct)
		mapChain implements LabelMap for a list of underlying LabelMap.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			maps []Map
		Methods (only one, which is exported)
			( mapChain) Find(key Key) Label
		Implements (at least one exported)
			 mapChain : Map

	 type stringptr unsafe.Pointer (basic type)
Package-Level Functions (total 7, all are exported)

	 func Filter(l List, keys ...Key) List
	 func MergeMaps(srcs ...Map) Map
	 func NewList(labels ...Label) List
	 func NewMap(labels ...Label) Map
	 func Of64(k Key, v uint64) Label
		Of64 creates a new label from a key and a uint64. This is often
		used for non uint64 values that can be packed into a uint64.
		This method is for implementing new key types, label creation should
		normally be done with the Of method of the key.

	 func OfString(k Key, v string) Label
		OfString creates a new label from a key and a string.
		This method is for implementing new key types, label creation should
		normally be done with the Of method of the key.

	 func OfValue(k Key, value interface{}) Label
		OfValue creates a new label from the key and value.
		This method is for implementing new key types, label creation should
		normally be done with the Of method of the key.


Package-Level Variables (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	  var emptyList *list

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)