package codes

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

Dependency Relation
	imports 0 packages, and imported by one package

Involved Source Files

	   d➜ codes.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/master/specification/trace/api.md#statuscanonicalcode).
		This also means that it follows gRPC codes and is based on
		[google.golang.org/grpc/codes](https://godoc.org/google.golang.org/grpc/codes).

		This package was added to this project, instead of using that existing
		package, to avoid the large package size it includes and not impose that
		burden on projects using this package.
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.

		As Inputs Of (at least 3, all are exported)
			func go.opentelemetry.io/otel/api/trace.WithErrorStatus(s Code) trace.ErrorOption
			func go.opentelemetry.io/otel/api/trace.NoopSpan.SetStatus(status Code, msg string)
			func go.opentelemetry.io/otel/api/trace.Span.SetStatus(Code, string)
		As Types Of (total 17, all are exported)
			const Aborted
			const AlreadyExists
			const Canceled
			const DataLoss
			const DeadlineExceeded
			const FailedPrecondition
			const Internal
			const InvalidArgument
			const NotFound
			const OK
			const OutOfRange
			const PermissionDenied
			const ResourceExhausted
			const Unauthenticated
			const Unavailable
			const Unimplemented
			const Unknown


Package-Level Constants (total 17, all are exported)

	const Aborted Code = 10
		Aborted means the operation was aborted, typically due to a concurrency
		issue like sequencer check failures, transaction aborts, etc.

	const AlreadyExists Code = 6
		AlreadyExists means some entity that we attempted to create (e.g., file
		or directory) already exists.

	const Canceled Code = 1
		Canceled indicates the operation was canceled (typically by the
		caller).

	const DataLoss Code = 15
		DataLoss means unrecoverable data loss or corruption has occurred.

	const DeadlineExceeded Code = 4
		DeadlineExceeded means a deadline expired before the operation could
		complete. For operations that change the state of the system, this error
		may be returned even if the operation has completed successfully.

	const FailedPrecondition Code = 9
		FailedPrecondition means the operation was rejected because the system
		is not in a state required for the operation's execution.

	const Internal Code = 13
		Internal means an internal errors. It means some invariants expected by
		underlying system has been broken.

	const InvalidArgument Code = 3
		InvalidArgument indicates a client specified an invalid argument. Note
		that this differs from FailedPrecondition. InvalidArgument indicates
		arguments that are problematic regardless of the state of the system.

	const NotFound Code = 5
		NotFound means some requested entity (e.g., file or directory) was not
		found.

	const OK Code = 0
		OK means success.

	const OutOfRange Code = 11
		OutOfRange means the operation was attempted past the valid range.
		E.g., seeking or reading past end of file. Unlike InvalidArgument, this
		error indicates a problem that may be fixed if the system state
		changes.

	const PermissionDenied Code = 7
		PermissionDenied means the caller does not have permission to execute
		the specified operation. PermissionDenied must not be used if the caller
		cannot be identified (use Unauthenticated instead for those errors).

	const ResourceExhausted Code = 8
		ResourceExhausted means some resource has been exhausted, perhaps a
		per-user quota, or perhaps the entire file system is out of space.

	const Unauthenticated Code = 16
		Unauthenticated means the request does not have valid authentication
		credentials for the operation.

	const Unavailable Code = 14
		Unavailable means the service is currently unavailable. This is most
		likely a transient condition and may be corrected by retrying with a
		backoff.

	const Unimplemented Code = 12
		Unimplemented means the operation is not implemented or not
		supported/enabled in this service.

	const Unknown Code = 2
		Unknown error. An example of where this error may be returned is if an
		error is raised by a dependant API that does not contain enough
		information to convert it into a more appropriate error.

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.