package status

Import Path
	google.golang.org/grpc/internal/status (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 3 packages

Involved Source Files

	  d status.go
		Package status implements errors returned by gRPC.  These errors are
		serialized and transmitted on the wire between server and client, and allow
		for additional data to be transmitted via the Details field in the status
		proto.  gRPC service handlers should return an error created by this
		package, and gRPC clients should expect a corresponding error to be
		returned from the RPC call.
		
		This package upholds the invariants that a non-nil error may not
		contain an OK code, and an OK code must result in a nil error.
Package-Level Type Names (total 2, both are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Error (struct)
		Error wraps a pointer of a status proto. It implements error and Status,
		and a nil *Error should never be returned by this package.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			s *Status
		Methods (total 3, all are exported)
			(*Error) Error() string
			(*Error) GRPCStatus() *Status
				GRPCStatus returns the Status represented by se.

			(*Error) Is(target error) bool
				Is implements future error.Is functionality.
				A Error is equivalent if the code and message are identical.

		Implements (at least one exported)
			*Error : error

	 type Status (struct)
		Status represents an RPC status code, message, and details.  It is immutable
		and should be created with New, Newf, or FromProto.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			s *spb.Status
		Methods (total 7, all are exported)
			(*Status) Code() codes.Code
				Code returns the status code contained in s.

			(*Status) Details() []any
				Details returns a slice of details messages attached to the status.
				If a detail cannot be decoded, the error is returned in place of the detail.
				If the detail can be decoded, the proto message returned is of the same
				type that was given to WithDetails().

			(*Status) Err() error
				Err returns an immutable error representing s; returns nil if s.Code() is OK.

			(*Status) Message() string
				Message returns the message contained in s.

			(*Status) Proto() *spb.Status
				Proto returns s's status as an spb.Status proto message.

			(*Status) String() string
			(*Status) WithDetails(details ...protoadapt.MessageV1) (*Status, error)
				WithDetails returns a new status with the provided details messages appended to the status.
				If any errors are encountered, it returns nil and the first error encountered.

		Implements (at least 4, in which 2 are exported)
			*Status : expvar.Var
			*Status : fmt.Stringer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*Status : context.stringer
			*Status : runtime.stringer
		As Outputs Of (at least 14, in which 13 are exported)
			func FromProto(s *spb.Status) *Status
			func New(c codes.Code, msg string) *Status
			func Newf(c codes.Code, format string, a ...any) *Status
			func NewWithProto(code codes.Code, message string, statusProto []string) *Status
			func (*Error).GRPCStatus() *Status
			func (*Status).WithDetails(details ...protoadapt.MessageV1) (*Status, error)
			func google.golang.org/grpc/internal/transport.(*ClientStream).Status() *status.Status
			func google.golang.org/grpc/status.Convert(err error) *status.Status
			func google.golang.org/grpc/status.FromContextError(err error) *status.Status
			func google.golang.org/grpc/status.FromError(err error) (s *status.Status, ok bool)
			func google.golang.org/grpc/status.FromProto(s *spb.Status) *status.Status
			func google.golang.org/grpc/status.New(c codes.Code, msg string) *status.Status
			func google.golang.org/grpc/status.Newf(c codes.Code, format string, a ...any) *status.Status
			/* at least one unexported ... *//* at least one unexported: */
			func google.golang.org/grpc.checkRecvPayload(pf grpc.payloadFormat, recvCompress string, haveCompressor bool, isServer bool) *status.Status
		As Inputs Of (at least 3, all are exported)
			func IsRestrictedControlPlaneCode(s *Status) bool
			func RawStatusProto(s *Status) *spb.Status
			func google.golang.org/grpc/internal/transport.(*ServerStream).WriteStatus(st *status.Status) error
		As Types Of (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			  var google.golang.org/grpc/internal/transport.statusGoAway *Status
			  var google.golang.org/grpc.statusOK *Status


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

	 func Err(c codes.Code, msg string) error
		Err returns an error representing c and msg.  If c is OK, returns nil.

	 func Errorf(c codes.Code, format string, a ...any) error
		Errorf returns Error(c, fmt.Sprintf(format, a...)).

	 func FromProto(s *spb.Status) *Status
		FromProto returns a Status representing s.

	 func IsRestrictedControlPlaneCode(s *Status) bool
		IsRestrictedControlPlaneCode returns whether the status includes a code
		restricted for control plane usage as defined by gRFC A54.

	 func New(c codes.Code, msg string) *Status
		New returns a Status representing c and msg.

	 func Newf(c codes.Code, format string, a ...any) *Status
		Newf returns New(c, fmt.Sprintf(format, a...)).

	 func NewWithProto(code codes.Code, message string, statusProto []string) *Status
		NewWithProto returns a new status including details from statusProto.  This
		is meant to be used by the gRPC library only.

	 func RawStatusProto(s *Status) *spb.Status
		RawStatusProto returns the internal protobuf message for use by gRPC itself.

The pages are generated with Golds v0.7.6. (GOOS=linux GOARCH=amd64)