status

package
v0.0.0-...-2aa3dc7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 4, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	OK   = New(CodeOK, "")
	None = New(CodeNone, "")
)
View Source 
var (
	End  = New(CodeEnd, "")
	Wait = New(CodeWait, "")
)
View Source 
var (
	Closed    = New(CodeClosed, "")
	Cancelled = New(CodeCancelled, "")
	Timeout   = New(CodeTimeout, "")
)

Functions

func ToError 

func ToError(s Status) error

ToError converts a status into an error, or returns nil if the status is OK.

Types

type Code 

type Code string
const (
	// CodeNone indicates an undefined status code.
	CodeNone Code = ""

	// CodeOK indicates that an operation completed successfully.
	CodeOK Code = "ok"

	// CodeTest is a status code for testing.
	CodeTest Code = "test"
)

General class 

const (
	// CodeError indicates an internal general purpose error.
	CodeError Code = "error"

	// CodeExternalError indicates an external error, i.e. an invalid argument, validation error, etc.
	CodeExternalError Code = "external_error"
)

Error class 

const (
	// CodeNotFound indicates that an object is not found.
	CodeNotFound Code = "not_found"

	// CodeForbidden indicates that an operation is forbidden.
	CodeForbidden Code = "forbidden"

	// CodeUnauthorized indicates that a user is not authorized.
	CodeUnauthorized Code = "unauthorized"
)

Invalid class 

const (
	// CodeClosed indicates that an object is closed and cannot be used anymore.
	CodeClosed Code = "closed"

	// CodeCancelled indicates that an operation was cancelled or stopped on a request.
	CodeCancelled Code = "cancelled"

	// CodeRedirect indicates that an operation was redirected.
	CodeRedirect Code = "redirect"

	// CodeTimeout indicates that an operation timed out.
	CodeTimeout Code = "timeout"

	// CodeUnavailable indicates that a service is temporarily unavailable, the operation can be retried.
	CodeUnavailable Code = "unavailable"

	// CodeUnsupported indicates that an operation is not supported or not implemented.
	CodeUnsupported Code = "unsupported"
)

Unavailable class 

const (
	// CodeEnd indicates a file/channel/stream end.
	CodeEnd Code = "end"

	// CodeWait indicates that the caller should wait for the next events/messages/etc.
	CodeWait Code = "wait"
)

Iteration/streaming class 

const (
	// CodeParseError indicates that a data cannot be parsed.
	CodeParseError Code = "parse_error"

	// CodeChecksumError indicates that a checksum does not match the expected checksum.
	CodeChecksumError Code = "checksum_error"
)

Parsing/serializing class 

const (
	// CodeConcurrencyError indicates that a data read/write cannot be serialized.
	CodeConcurrencyError Code = "concurrency_error"

	// CodeRollback indicates that an operation was rolled backed.
	CodeRollback Code = "rollback" // TODO: Maybe remove
)

Database class

type Err 

type Err struct {
	Code    Code
	Message string
	Cause   error
}

Err is a status error.

func (*Err) Error 

func (e *Err) Error() string

Error implements the error interface.

func (*Err) Status 

func (e *Err) Status() Status

Status converts the error into a status.

type Status 

type Status struct {
	Code    Code
	Message string
	Error   error
}

Status represents an operation status.

func Cancelledf 

func Cancelledf(format string, a ...any) Status

Cancelledf formats a message and returns a cancelled status.

func ChecksumError 

func ChecksumError(msg string) Status

ChecksumError returns a data corruption error status.

func ChecksumErrorf 

func ChecksumErrorf(format string, a ...any) Status

ChecksumErrorf formats and returns a data corruption error status.

func Closedf 

func Closedf(format string, a ...any) Status

Closedf formats a message and returns a closed status.

func ConcurrencyError 

func ConcurrencyError(msg string) Status

ConcurrencyError returns a concurrency error status.

func ConcurrencyErrorf 

func ConcurrencyErrorf(format string, a ...any) Status

ConcurrencyErrorf formats a message and returns a concurrency error status.

func Endf 

func Endf(format string, a ...any) Status

func Error 

func Error(msg string) Status

Error returns an internal error status.

func Errorf 

func Errorf(format string, a ...any) Status

Errorf formats and returns an internal error status.

func ExternalError 

func ExternalError(msg string) Status

ExternalError returns an external error status.

func ExternalErrorf 

func ExternalErrorf(format string, a ...any) Status

ExternalErrorf formats and returns an external error status.

func Forbidden 

func Forbidden(msg string) Status

Forbidden returns a forbidden status.

func Forbiddenf 

func Forbiddenf(format string, a ...any) Status

Forbiddenf formats a message and returns a forbidden status.

func New 

func New(code Code, msg string) Status

New returns a new status.

func Newf 

func Newf(code Code, format string, a ...any) Status

Newf returns a new status and formats its message.

func Nonef 

func Nonef(format string, a ...any) Status

Nonef formats a message and returns a none status.

func NotFound 

func NotFound(msg string) Status

NotFound returns a not found status.

func NotFoundf 

func NotFoundf(format string, a ...any) Status

NotFoundf formats a message and returns a not found status.

func OKf 

func OKf(format string, a ...any) Status

OKf formats a message and returns an ok status.

func ParseError 

func ParseError(msg string) Status

ParseError returns a data corruption error status.

func ParseErrorf 

func ParseErrorf(format string, a ...any) Status

ParseErrorf formats and returns a data corruption error status.

func Recover 

func Recover(e any) Status

Recover recovers from a panic and returns an internal error status.

func RecoverStack 

func RecoverStack(e any) (Status, []byte)

RecoverStack recovers from a panic and returns an internal error status and a stack trace.

func Redirect 

func Redirect(msg string) Status

Redirect returns a redirect status.

func Redirectf 

func Redirectf(format string, a ...any) Status

Redirectf formats a message and returns a redirect status.

func Rollback 

func Rollback(msg string) Status

Rollback returns a rollback status.

func Rollbackf 

func Rollbackf(format string, a ...any) Status

Rollbackf formats a message and returns a rollback status.

func Test 

func Test(message string) Status

Test returns a test status.

func Testf 

func Testf(format string, a ...any) Status

Testf formats a message and returns a test status.

func Timeoutf 

func Timeoutf(format string, a ...any) Status

Timeoutf returns a timeout status and formats its message.

func Unauthorized 

func Unauthorized(msg string) Status

Unauthorized returns an unauthorized status.

func Unauthorizedf 

func Unauthorizedf(format string, a ...any) Status

Unauthorizedf formats a message and returns an unauthorized status.

func Unavailable 

func Unavailable(msg string) Status

Unavailable returns an unavailable status.

func Unavailablef 

func Unavailablef(format string, a ...any) Status

Unavailablef returns an unavailable status and formats its message.

func Unsupported 

func Unsupported(msg string) Status

Unsupported returns an unsupported status.

func Unsupportedf 

func Unsupportedf(format string, a ...any) Status

Unsupportedf returns an unsupported status and formats its message.

func WrapChecksumError 

func WrapChecksumError(err error) Status

WrapChecksumError returns a data corruption error status.

func WrapChecksumErrorf 

func WrapChecksumErrorf(err error, format string, a ...any) Status

WrapChecksumErrorf formats and returns a data corruption error status.

func WrapError 

func WrapError(err error) Status

WrapError returns an internal error status.

func WrapErrorf 

func WrapErrorf(err error, format string, a ...any) Status

WrapErrorf formats and returns an internal error status.

func WrapExternalError 

func WrapExternalError(err error) Status

WrapExternalError returns an external error status.

func WrapExternalErrorf 

func WrapExternalErrorf(err error, format string, a ...any) Status

WrapExternalErrorf formats and returns an external error status.

func WrapParseError 

func WrapParseError(err error) Status

WrapParseError returns a data corruption error status.

func WrapParseErrorf 

func WrapParseErrorf(err error, format string, a ...any) Status

WrapParseErrorf formats and returns a data corruption error status.

func (Status) Cancelled 

func (s Status) Cancelled() bool

Cancelled returns true if the status code is Cancelled.

func (Status) OK 

func (s Status) OK() bool

OK returns true if the status code is OK.

func (Status) String 

func (s Status) String() string

String returns "code: msg".

func (Status) ToError 

func (s Status) ToError() error

ToError returns a new error from the status, or nil if OK.

func (Status) WithCode 

func (s Status) WithCode(code Code) Status

WithCode returns a status clone with a new code.

func (Status) WithError 

func (s Status) WithError(err error) Status

WithError returns a status clone with a new error.

func (Status) WrapText 

func (s Status) WrapText(msg string) Status

WrapText returns a status clone with a new msg and an appended previous msg.

func (Status) WrapTextf 

func (s Status) WrapTextf(format string, a ...any) Status

WrapTextf returns a status clone with a new msg and an appended previous msg.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.