errors

errors

import "github.com/Azure/iot-operations-sdks/go/protocol/errors"

Index

• func Context(ctx context.Context, msg string) error
• func Normalize(err error, msg string) error
• type Error
  • func (e *Error) Error() string
• type Kind

func Context

func Context(ctx context.Context, msg string) error

Context extracts the timeout or cancellation error from a context.

func Normalize

func Normalize(err error, msg string) error

Normalize well-known errors into protocol errors.

type Error

Error represents a structured protocol error.

type Error struct {
    Message string
    Kind    Kind

    NestedError error

    HeaderName  string
    HeaderValue string

    TimeoutName  string
    TimeoutValue time.Duration

    PropertyName  string
    PropertyValue any

    InApplication  bool
    IsShallow      bool
    IsRemote       bool
    HTTPStatusCode int
}

func (*Error) Error

func (e *Error) Error() string

Error returns the error as a string.

type Kind

Kind defines the type of error being thrown.

type Kind int

The following are the defined error kinds.

const (
    HeaderMissing Kind = iota
    HeaderInvalid
    PayloadInvalid
    Timeout
    Cancellation
    ConfigurationInvalid
    ArgumentInvalid
    StateInvalid
    InternalLogicError
    UnknownError
    InvocationException
    ExecutionException
    MqttError
)

Generated by gomarkdoc