status

Documentation

Overview

Package status contains helpers functions to create grpc Status with contextual information, like traces.

Index

• func HTTPStatusFromCode(code rpc.Code) int
• func NewAborted(ctx context.Context, err error, msg string) *rpc.Status
• func NewAlreadyExists(ctx context.Context, err error, msg string) *rpc.Status
• func NewConflict(ctx context.Context, err error, msg string) *rpc.Status
• func NewErrorFromCode(code rpc.Code, pkgname string) error
• func NewFailedPrecondition(ctx context.Context, err error, msg string) *rpc.Status
• func NewInsufficientStorage(ctx context.Context, err error, msg string) *rpc.Status
• func NewInternal(ctx context.Context, msg string) *rpc.Status
• func NewInvalid(ctx context.Context, msg string) *rpc.Status
• func NewLocked(ctx context.Context, msg string) *rpc.Status
• func NewNotFound(ctx context.Context, msg string) *rpc.Status
• func NewOK(ctx context.Context) *rpc.Status
• func NewPermissionDenied(ctx context.Context, err error, msg string) *rpc.Status
• func NewStatusFromErrType(ctx context.Context, msg string, err error) *rpc.Status
• func NewUnauthenticated(ctx context.Context, err error, msg string) *rpc.Status
• func NewUnimplemented(ctx context.Context, err error, msg string) *rpc.Status

Functions

func HTTPStatusFromCode

func HTTPStatusFromCode(code rpc.Code) int

HTTPStatusFromCode returns an HTTP status code for the rpc code. It returns an internal server error (500) if the code is unknown

func NewAborted

func NewAborted(ctx context.Context, err error, msg string) *rpc.Status

NewAborted returns a Status with ABORTED.

func NewAlreadyExists

func NewAlreadyExists(ctx context.Context, err error, msg string) *rpc.Status

NewAlreadyExists returns a Status with CODE_ALREADY_EXISTS.

func NewConflict

func NewConflict(ctx context.Context, err error, msg string) *rpc.Status

NewConflict returns a Status with Code_CODE_ABORTED.

Deprecated: NewConflict exists for historical compatibility and should not be used. To create a Status with code ABORTED, use NewAborted.

func NewErrorFromCode

func NewErrorFromCode(code rpc.Code, pkgname string) error

NewErrorFromCode returns a standardized Error for a given RPC code.

func NewFailedPrecondition

func NewFailedPrecondition(ctx context.Context, err error, msg string) *rpc.Status

NewFailedPrecondition returns a Status with FAILED_PRECONDITION.

func NewInsufficientStorage

func NewInsufficientStorage(ctx context.Context, err error, msg string) *rpc.Status

NewInsufficientStorage returns a Status with INSUFFICIENT_STORAGE.

func NewInternal

func NewInternal(ctx context.Context, msg string) *rpc.Status

NewInternal returns a Status with CODE_INTERNAL.

func NewInvalid

func NewInvalid(ctx context.Context, msg string) *rpc.Status

NewInvalid returns a Status with CODE_INVALID_ARGUMENT.

func NewLocked

func NewLocked(ctx context.Context, msg string) *rpc.Status

NewLocked returns a status Code_CODE_LOCKED

func NewNotFound

func NewNotFound(ctx context.Context, msg string) *rpc.Status

NewNotFound returns a Status with CODE_NOT_FOUND.

func NewOK

func NewOK(ctx context.Context) *rpc.Status

NewOK returns a Status with CODE_OK.

func NewPermissionDenied

func NewPermissionDenied(ctx context.Context, err error, msg string) *rpc.Status

NewPermissionDenied returns a Status with PERMISSION_DENIED.

func NewStatusFromErrType

func NewStatusFromErrType(ctx context.Context, msg string, err error) *rpc.Status

NewStatusFromErrType returns a status that corresponds to the given errtype

func NewUnauthenticated

func NewUnauthenticated(ctx context.Context, err error, msg string) *rpc.Status

NewUnauthenticated returns a Status with CODE_UNAUTHENTICATED.

func NewUnimplemented

func NewUnimplemented(ctx context.Context, err error, msg string) *rpc.Status

NewUnimplemented returns a Status with CODE_UNIMPLEMENTED.