package tracestate

Import Path
	go.opencensus.io/trace/tracestate (on go.dev)

Dependency Relation
	imports 2 packages, and imported by one package

Involved Source Files

	   d➜ tracestate.go
		Package tracestate implements support for the Tracestate header of the
		W3C TraceContext propagation format.
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Entry (struct)
		Entry represents one key-value pair in a list of key-value pair of Tracestate.

		Fields (total 2, both are exported)
			Key string
				Key is an opaque string up to 256 characters printable. It MUST begin with a lowercase letter,
				and can only contain lowercase letters a-z, digits 0-9, underscores _, dashes -, asterisks *, and
				forward slashes /.

			Value string
				Value is an opaque string up to 256 characters printable ASCII RFC0020 characters (i.e., the
				range 0x20 to 0x7E) except comma , and =.

		As Outputs Of (at least 3, in which 1 are exported)
			func (*Tracestate).Entries() []Entry
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func areEntriesValid(entries ...Entry) (*Entry, bool)
			func (*Tracestate).remove(key string) *Entry
		As Inputs Of (at least 5, in which 1 are exported)
			func New(parent *Tracestate, entries ...Entry) (*Tracestate, error)
			/* 4+ unexporteds ... *//* 4+ unexporteds: */
			func areEntriesValid(entries ...Entry) (*Entry, bool)
			func containsDuplicateKey(entries ...Entry) (string, bool)
			func isValid(entry Entry) bool
			func (*Tracestate).add(entries []Entry) error

	 type Tracestate (struct)
		Tracestate represents tracing-system specific context in a list of key-value pairs. Tracestate allows different
		vendors propagate additional information and inter-operate with their legacy Id formats.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			entries []Entry
		Methods (total 3, in which 1 are exported)
			(*T) Entries() []Entry
				Entries returns a slice of Entry.

			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) add(entries []Entry) error
			(*T) remove(key string) *Entry
		As Outputs Of (at least one exported)
			func New(parent *Tracestate, entries ...Entry) (*Tracestate, error)
		As Inputs Of (at least one exported)
			func New(parent *Tracestate, entries ...Entry) (*Tracestate, error)


Package-Level Functions (total 4, in which 1 are exported)

	 func New(parent *Tracestate, entries ...Entry) (*Tracestate, error)
		New creates a Tracestate object from a parent and/or entries (key-value pair).
		Entries from the parent are copied if present. The entries passed to this function
		are inserted in front of those copied from the parent. If an entry copied from the
		parent contains the same key as one of the entry in entries then the entry copied
		from the parent is removed. See add func.

		An error is returned with nil Tracestate if
		 1. one or more entry in entries is invalid.
		 2. two or more entries in the input entries have the same key.
		 3. the number of entries combined from the parent and the input entries exceeds maxKeyValuePairs.
		    (duplicate entry is counted only once).

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func areEntriesValid(entries ...Entry) (*Entry, bool)
	 func containsDuplicateKey(entries ...Entry) (string, bool)
	 func isValid(entry Entry) bool
Package-Level Variables (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var keyValidationRegExp *regexp.Regexp
	  var valueValidationRegExp *regexp.Regexp
Package-Level Constants (total 7, none are exported)

	/* 7 unexporteds ... *//* 7 unexporteds: */
	const keyFormat = "([a-z][_0-9a-z\\-\\*\\/]{0,255})|([a-z][_0-9a-z\\-\\*\\/]{0,240}@[a-...
	const keyMaxSize = 256
	const keyWithoutVendorFormat = "[a-z][_0-9a-z\\-\\*\\/]{0,255}"
	const keyWithVendorFormat = "[a-z][_0-9a-z\\-\\*\\/]{0,240}@[a-z][_0-9a-z\\-\\*\\/]{0,13}"
	const maxKeyValuePairs = 32
	const valueFormat = "[\\x20-\\x2b\\x2d-\\x3c\\x3e-\\x7e]{0,255}[\\x21-\\x2b\\x2d-\\x3c\\x...
	const valueMaxSize = 256

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.