package codes

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

Dependency Relation
	imports 3 packages, and imported by one package

Involved Source Files

	    codes.go
	  d doc.go
		Package codes defines the canonical error codes used by OpenTelemetry.
		
		It conforms to [the OpenTelemetry
		specification](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.20.0/specification/trace/api.md#set-status).
Package-Level Type Names (only one, which is exported)

	/* sort exporteds by: alphabet | popularity */
	 type Code uint32 (basic type)
		Code is an 32-bit representation of a status state.

		Methods (total 3, all are exported)
			(*Code) MarshalJSON() ([]byte, error)
				MarshalJSON returns c as the JSON encoding of c.

			( Code) String() string
				String returns the Code as a string.

			(*Code) UnmarshalJSON(b []byte) error
				UnmarshalJSON unmarshals b into the Code.
				
				This is based on the functionality in the gRPC codes package:
				https://github.com/grpc/grpc-go/blob/bb64fee312b46ebee26be43364a7a966033521b1/codes/codes.go#L218-L244

		Implements (at least 5, in which 3 are exported)
			*Code : encoding/json.Marshaler
			*Code : encoding/json.Unmarshaler
			 Code : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			 Code : context.stringer
			 Code : runtime.stringer
		As Inputs Of (at least one exported)
			func go.opentelemetry.io/otel/trace.Span.SetStatus(code Code, description string)
		As Types Of (total 3, all are exported)
			const Error
			const Ok
			const Unset


Package-Level Variables (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	  var codeToStr map[Code]string
	  var strToCode map[string]Code
Package-Level Constants (total 4, in which 3 are exported)

	const Error Code = 1
		Error indicates the operation contains an error.
		
		NOTE: The error code in OTLP is 2.
		The value of this enum is only relevant to the internals
		of the Go SDK.

	const Ok Code = 2
		Ok indicates operation has been validated by an Application developers
		or Operator to have completed successfully, or contain no error.
		
		NOTE: The Ok code in OTLP is 1.
		The value of this enum is only relevant to the internals
		of the Go SDK.

	const Unset Code = 0
		Unset is the default status code.

	/* one unexported ... *//* one unexported: */
	const maxCode = 3

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