Documentation
¶
Overview ¶
Copyright (c) Microsoft Corporation. Licensed under the MIT License.
Copyright (c) Microsoft Corporation. Licensed under the MIT License.
Index ¶
- func IsKind[K Kind](err error) (K, bool)
- type Cancellation
- type Client
- type ConfigurationInvalid
- type ExecutionError
- type HeaderInvalid
- type HeaderMissing
- type InternalLogicError
- type Kind
- type MqttError
- type PayloadInvalid
- type Remote
- type StateInvalid
- type Timeout
- type UnknownError
- type UnsupportedVersion
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Cancellation ¶
type Cancellation struct{}
Cancellation errors indicate that the operation was canceled.
func (Cancellation) String ¶ added in v0.4.0
func (Cancellation) String() string
type ConfigurationInvalid ¶
ConfigurationInvalid errors indicate that a provided configuration value or argument is invalid.
func (ConfigurationInvalid) Attrs ¶ added in v0.4.0
func (e ConfigurationInvalid) Attrs() []slog.Attr
func (ConfigurationInvalid) String ¶ added in v0.4.0
func (ConfigurationInvalid) String() string
type ExecutionError ¶ added in v0.4.0
type ExecutionError struct{}
ExecutionError errors indicate that the command processor encountered an error while executing the command.
func (ExecutionError) String ¶ added in v0.4.0
func (ExecutionError) String() string
type HeaderInvalid ¶
HeaderInvalid errors indicate that an MQTT header property is has an invalid value in the received message.
func (HeaderInvalid) Attrs ¶ added in v0.4.0
func (e HeaderInvalid) Attrs() []slog.Attr
func (HeaderInvalid) String ¶ added in v0.4.0
func (HeaderInvalid) String() string
type HeaderMissing ¶
type HeaderMissing struct {
HeaderName string
}
HeaderMissing errors indicate that a required MQTT header property is missing from the received message.
func (HeaderMissing) Attrs ¶ added in v0.4.0
func (e HeaderMissing) Attrs() []slog.Attr
func (HeaderMissing) String ¶ added in v0.4.0
func (HeaderMissing) String() string
type InternalLogicError ¶
type InternalLogicError struct { // Deprecated: Only for wire protocol compat. PropertyName string }
InternalLogicError errors indicate that the client or service observed a condition that was thought to be impossible.
func (InternalLogicError) String ¶ added in v0.4.0
func (InternalLogicError) String() string
type Kind ¶
type Kind interface { String() string // contains filtered or unexported methods }
Kind defines the type of protocol error being thrown.
type MqttError ¶
type MqttError struct{}
MqttError errors indicate that the MQTT communication encountered an error and failed.
type PayloadInvalid ¶
type PayloadInvalid struct{}
PayloadInvalid errors indicate that the MQTT payload cannot be serialized/deserialized.
func (PayloadInvalid) String ¶ added in v0.4.0
func (PayloadInvalid) String() string
type Remote ¶ added in v0.4.0
Remote represents an error that is sent between services over the wire.
type StateInvalid ¶
type StateInvalid struct {
PropertyName string
}
StateInvalid errors indicate that the current program state is invalid relative to the method that was called.
func (StateInvalid) Attrs ¶ added in v0.4.0
func (e StateInvalid) Attrs() []slog.Attr
func (StateInvalid) String ¶ added in v0.4.0
func (StateInvalid) String() string
type UnknownError ¶
type UnknownError struct { // Deprecated: Only for schemaregistry compat. PropertyName string // Deprecated: Only for schemaregistry compat. PropertyValue any }
UnknownError errors indicate that the client or service received an unexpected error from a dependent component.
func (UnknownError) String ¶ added in v0.4.0
func (UnknownError) String() string
type UnsupportedVersion ¶ added in v0.4.0
UnsupportedVersion errors indicate that the command processor or receiver doesn't support the provided protocol version.
func (UnsupportedVersion) Attrs ¶ added in v0.4.0
func (e UnsupportedVersion) Attrs() []slog.Attr
func (UnsupportedVersion) String ¶ added in v0.4.0
func (UnsupportedVersion) String() string