package propagation

Import Path
	go.opentelemetry.io/otel/api/propagation (on go.dev)

Dependency Relation
	imports one package, and imported by 5 packages

Involved Source Files

	   d➜ doc.go
		Package propagation contains interface definition for HTTP propagators.

	      propagation.go
Package-Level Type Names (total 8, in which 7 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Config (struct)
		Config contains the current set of extractors and injectors.

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			httpEx []HTTPExtractor
			httpIn []HTTPInjector

	 type HTTPExtractor (interface)
		HTTPExtractor extracts information from a HTTPSupplier into a
		context.

		Methods (only one, which is exported)
			( T) Extract(context.Context, HTTPSupplier) context.Context
				Extract method retrieves encoded information using supplier
				from the associated carrier, decodes it and creates a new
				context containing the decoded information.

				Information can be a correlation context or a remote span
				context. In case of span context, the propagator should
				store it in the context using
				trace.ContextWithRemoteSpanContext. In case of correlation
				context, the propagator should use correlation.WithMap to
				store it in the context.

		Implemented By (at least 4, all are exported)
			 HTTPPropagator (interface)
			 go.opentelemetry.io/otel/api/correlation.CorrelationContext
			 go.opentelemetry.io/otel/api/trace.B3
			 go.opentelemetry.io/otel/api/trace.TraceContext
		As Outputs Of (at least 2, both are exported)
			func Propagators.HTTPExtractors() []HTTPExtractor
			func go.opentelemetry.io/otel.Propagators.HTTPExtractors() []HTTPExtractor
		As Inputs Of (at least one exported)
			func WithExtractors(ext ...HTTPExtractor) Option

	 type HTTPInjector (interface)
		HTTPInjector injects information into a HTTPSupplier.

		Methods (only one, which is exported)
			( T) Inject(context.Context, HTTPSupplier)
				Inject method retrieves information from the context,
				encodes it into propagator specific format and then injects
				the encoded information using supplier into an associated
				carrier.

		Implemented By (at least 4, all are exported)
			 HTTPPropagator (interface)
			 go.opentelemetry.io/otel/api/correlation.CorrelationContext
			 go.opentelemetry.io/otel/api/trace.B3
			 go.opentelemetry.io/otel/api/trace.TraceContext
		As Outputs Of (at least 2, both are exported)
			func Propagators.HTTPInjectors() []HTTPInjector
			func go.opentelemetry.io/otel.Propagators.HTTPInjectors() []HTTPInjector
		As Inputs Of (at least one exported)
			func WithInjectors(inj ...HTTPInjector) Option

	 type HTTPPropagator (interface)
		HTTPPropagator is the interface to inject to and extract from
		HTTPSupplier.

		Methods (total 3, all are exported)
			( T) Extract(context.Context, HTTPSupplier) context.Context
				Extract method retrieves encoded information using supplier
				from the associated carrier, decodes it and creates a new
				context containing the decoded information.

				Information can be a correlation context or a remote span
				context. In case of span context, the propagator should
				store it in the context using
				trace.ContextWithRemoteSpanContext. In case of correlation
				context, the propagator should use correlation.WithMap to
				store it in the context.

			( T) GetAllKeys() []string
				GetAllKeys returns the HTTP header names used.

			( T) Inject(context.Context, HTTPSupplier)
				Inject method retrieves information from the context,
				encodes it into propagator specific format and then injects
				the encoded information using supplier into an associated
				carrier.

		Implemented By (at least 3, all are exported)
			 go.opentelemetry.io/otel/api/correlation.CorrelationContext
			 go.opentelemetry.io/otel/api/trace.B3
			 go.opentelemetry.io/otel/api/trace.TraceContext
		Implements (at least 2, both are exported)
			 T : HTTPExtractor
			 T : HTTPInjector
		As Outputs Of (at least 2, both are exported)
			func go.opentelemetry.io/otel/api/correlation.DefaultHTTPPropagator() HTTPPropagator
			func go.opentelemetry.io/otel/api/trace.DefaultHTTPPropagator() HTTPPropagator

	 type HTTPSupplier (interface)
		HTTPSupplier is an interface that specifies methods to retrieve and
		store a single value for a key to an associated carrier. It is
		implemented by http.Headers.

		Methods (total 2, both are exported)
			( T) Get(key string) string
				Get method retrieves a single value for a given key.

			( T) Set(key string, value string)
				Set method stores a single value for a given key. Note that
				this should not be appending a value to some array, but
				rather overwrite the old value.

		Implemented By (at least 4, all are exported)
			 google.golang.org/api/internal/gensupport.URLParams
			 net/http.Header
			 net/textproto.MIMEHeader
			 net/url.Values
		Implements (at least one exported)
			 T : github.com/go-redis/redis/v8.ConsistentHash
		As Inputs Of (at least 13, in which 12 are exported)
			func ExtractHTTP(ctx context.Context, props Propagators, supplier HTTPSupplier) context.Context
			func InjectHTTP(ctx context.Context, props Propagators, supplier HTTPSupplier)
			func HTTPExtractor.Extract(context.Context, HTTPSupplier) context.Context
			func HTTPInjector.Inject(context.Context, HTTPSupplier)
			func HTTPPropagator.Extract(context.Context, HTTPSupplier) context.Context
			func HTTPPropagator.Inject(context.Context, HTTPSupplier)
			func go.opentelemetry.io/otel/api/correlation.CorrelationContext.Extract(ctx context.Context, supplier HTTPSupplier) context.Context
			func go.opentelemetry.io/otel/api/correlation.CorrelationContext.Inject(ctx context.Context, supplier HTTPSupplier)
			func go.opentelemetry.io/otel/api/trace.B3.Extract(ctx context.Context, supplier HTTPSupplier) context.Context
			func go.opentelemetry.io/otel/api/trace.B3.Inject(ctx context.Context, supplier HTTPSupplier)
			func go.opentelemetry.io/otel/api/trace.TraceContext.Extract(ctx context.Context, supplier HTTPSupplier) context.Context
			func go.opentelemetry.io/otel/api/trace.TraceContext.Inject(ctx context.Context, supplier HTTPSupplier)
			/* at least one unexported ... *//* at least one unexported: */
			func go.opentelemetry.io/otel/api/trace.TraceContext.extract(supplier HTTPSupplier) trace.SpanContext

	 type Option (func)
		Option support passing configuration parameters to New().

		As Outputs Of (at least 2, both are exported)
			func WithExtractors(ext ...HTTPExtractor) Option
			func WithInjectors(inj ...HTTPInjector) Option
		As Inputs Of (at least one exported)
			func New(options ...Option) Propagators

	 type Propagators (interface)
		Propagators is the interface to a set of injectors and extractors
		for all supported carrier formats. It can be used to chain multiple
		propagators into a single entity.

		Methods (total 2, both are exported)
			( T) HTTPExtractors() []HTTPExtractor
				HTTPExtractors returns the configured extractors.

			( T) HTTPInjectors() []HTTPInjector
				HTTPInjectors returns the configured injectors.

		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*propagators
		As Outputs Of (at least 4, in which 3 are exported)
			func New(options ...Option) Propagators
			func go.opentelemetry.io/otel/api/global.Propagators() Propagators
			func go.opentelemetry.io/otel/api/global/internal.Propagators() Propagators
			/* at least one unexported ... *//* at least one unexported: */
			func go.opentelemetry.io/otel/api/global/internal.getDefaultPropagators() Propagators
		As Inputs Of (at least 4, all are exported)
			func ExtractHTTP(ctx context.Context, props Propagators, supplier HTTPSupplier) context.Context
			func InjectHTTP(ctx context.Context, props Propagators, supplier HTTPSupplier)
			func go.opentelemetry.io/otel/api/global.SetPropagators(p Propagators)
			func go.opentelemetry.io/otel/api/global/internal.SetPropagators(pr Propagators)

	/* one unexported ... *//* one unexported: */
	 type propagators (struct)
		propagators is the default Propagators implementation.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			config Config
		Methods (total 2, both are exported)
			(*T) HTTPExtractors() []HTTPExtractor
				HTTPExtractors implements Propagators.

			(*T) HTTPInjectors() []HTTPInjector
				HTTPInjectors implements Propagators.

		Implements (at least one exported)
			*T : Propagators


Package-Level Functions (total 5, all are exported)

	 func ExtractHTTP(ctx context.Context, props Propagators, supplier HTTPSupplier) context.Context
		ExtractHTTP applies props.HTTPExtractors() to the passed context
		and the supplier and returns the combined result context.

	 func InjectHTTP(ctx context.Context, props Propagators, supplier HTTPSupplier)
		InjectHTTP applies props.HTTPInjectors() to the passed context and
		the supplier.

	 func New(options ...Option) Propagators
		New returns a standard Propagators implementation.

	 func WithExtractors(ext ...HTTPExtractor) Option
		WithExtractors appends to the optional extractor set.

	 func WithInjectors(inj ...HTTPInjector) Option
		WithInjectors appends to the optional injector set.

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.