Retracted: these held pkg/ and internal/, now a module per pkg/v1 family and github.com/kitsunium/sdk/internal (ADR 0171): go get github.com/kitsunium/sdk@latest && go mod tidy
Documentation
¶
Overview ¶
Package cbor declares the error codes and the sentinels of the CBOR codec, internal/service/data/codec/cbor — range 0.3.6.* (ADR 0005 service/data/codec/cbor block).
The codes live in the core at the path that mirrors the package emitting them (ADR 0160 §2) and keep the values they were allocated with: the LL byte 3 records the layer that allocated the range, not the directory that declares it today (ADR 0160 §3). Nothing here encodes or decodes — the mechanism, and the constructors that attach a failure's detail, stay in the service package.
Package cbor — the sentinel *errs.Error values, one per code. Each Reason derives from its var name or from its Code constant (ADR 0020); the Public and Private texts are the ones the service package always emitted, so moving the declaration changed no rendering.
Index ¶
Constants ¶
const CodeCBORMarshalFailed errs.Code = 0x00_03_06_01 // 0.3.6.1
CodeCBORMarshalFailed identifies an encoding failure: a value of a type CBOR cannot carry, a string that is not UTF-8, a nesting deeper than the decoder accepts, a failing writer, MarshalBinary or MarshalCBOR.
const CodeCBORUnmarshalFailed errs.Code = 0x00_03_06_02 // 0.3.6.2
CodeCBORUnmarshalFailed identifies a decoding failure: input that is not one well-formed, valid data item, a bound exceeded, or an item the target cannot hold.
Variables ¶
var ( // MarshalFailed is the sentinel every encoding failure matches: a value // CBOR cannot carry, a string that is not UTF-8, a nesting deeper than // the decoder accepts, a failing writer, MarshalBinary or MarshalCBOR. MarshalFailed = errs.Define(CodeCBORMarshalFailed, "MARSHAL_FAILED", "CBOR encoding failed", "service/data/codec/cbor: a value could not be encoded as CBOR") // UnmarshalFailed is the sentinel every decoding failure matches: input // that is not one well-formed, valid data item, a bound exceeded, or an // item the target cannot hold. UnmarshalFailed = errs.Define(CodeCBORUnmarshalFailed, "UNMARSHAL_FAILED", "CBOR decoding failed", "service/data/codec/cbor: the input could not be decoded as CBOR") )
Sentinels, matched with errors.Is or errs.HasCode / errs.HasReason.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Source Files