package envconfig

Import Path
	go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc/internal/envconfig (on go.dev)

Dependency Relation
	imports 10 packages, and imported by one package

Involved Source Files

	  d envconfig.go
		Package envconfig provides functionality to parse configuration from
		environment variables.
Package-Level Type Names (total 2)

	/* sort by: alphabet | popularity */
	 type ConfigFn (func)
		ConfigFn is the generic function used to set a config.

		As Outputs Of (at least 3)
			func WithBool(n string, fn func(bool)) ConfigFn
			func WithCertPool(n string, fn func(*x509.CertPool)) ConfigFn
			func WithClientCert(nc, nk string, fn func(tls.Certificate)) ConfigFn
		As Inputs Of (at least one exported)
			func (*EnvOptionsReader).Apply(opts ...ConfigFn)

	 type EnvOptionsReader (struct)
		EnvOptionsReader reads the required environment variables.

		Fields (total 3)
			GetEnv func(string) string
			Namespace string
			ReadFile func(string) ([]byte, error)
		Methods (total 2)
			(*EnvOptionsReader) Apply(opts ...ConfigFn)
				Apply runs every ConfigFn.

			(*EnvOptionsReader) GetEnvValue(key string) (string, bool)
				GetEnvValue gets an OTLP environment variable value of the specified key
				using the GetEnv function.
				This function prepends the OTLP specified namespace to all key lookups.

		As Types Of (only one)
			  var go.opentelemetry.io/otel/exporters/otlp/otlptrace/otlptracegrpc/internal/otlpconfig.DefaultEnvOptionsReader


Package-Level Functions (total 7)

	 func WithBool(n string, fn func(bool)) ConfigFn
		WithBool returns a ConfigFn that reads the environment variable n and if it exists passes its parsed bool value to fn.

	 func WithCertPool(n string, fn func(*x509.CertPool)) ConfigFn
		WithCertPool returns a ConfigFn that reads the environment variable n as a filepath to a TLS certificate pool. If it exists, it is parsed as a crypto/x509.CertPool and it is passed to fn.

	 func WithClientCert(nc, nk string, fn func(tls.Certificate)) ConfigFn
		WithClientCert returns a ConfigFn that reads the environment variable nc and nk as filepaths to a client certificate and key pair. If they exists, they are parsed as a crypto/tls.Certificate and it is passed to fn.

	 func WithDuration(n string, fn func(time.Duration)) func(e *EnvOptionsReader)
		WithDuration retrieves the specified config and passes it to ConfigFn as a duration.

	 func WithHeaders(n string, fn func(map[string]string)) func(e *EnvOptionsReader)
		WithHeaders retrieves the specified config and passes it to ConfigFn as a map of HTTP headers.

	 func WithString(n string, fn func(string)) func(e *EnvOptionsReader)
		WithString retrieves the specified config and passes it to ConfigFn as a string.

	 func WithURL(n string, fn func(*url.URL)) func(e *EnvOptionsReader)
		WithURL retrieves the specified config and passes it to ConfigFn as a net/url.URL.

The pages are generated with Golds v0.8.2. (GOOS=linux 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 @zigo_101 (reachable from the left QR code) to get the latest news of Golds.