decode.go RawHistoryFolder

1package protocol
2
3import "fmt"
4
5// DecodeCategory classifies encoded input rejected before it reaches a use case.
6type DecodeCategory uint8
7
8const (
9	DecodeMalformed DecodeCategory = iota + 1
10	DecodeUnknownType
11	DecodeWrongDirection
12)
13
14// DecodeMessageKind identifies message families whose malformed prefixes need
15// compatibility responses before a typed message can be produced.
16type DecodeMessageKind uint8
17
18const (
19	DecodeMessageUnknown DecodeMessageKind = iota
20	DecodeMessageHello
21	DecodeMessageCommand
22	DecodeMessageKill
23	DecodeMessageRemotePreview
24	DecodeMessageNavigationInventory
25)
26
27// DecodeFailure describes rejected encoded input without retaining payload bytes.
28type DecodeFailure struct {
29	Category     DecodeCategory
30	Kind         DecodeMessageKind
31	Type         uint8
32	Version      uint16
33	RequestID    uint64
34	HasRequestID bool
35	Err          error
36}
37
38func (e *DecodeFailure) Error() string {
39	if e == nil {
40		return "protocol: decode failure"
41	}
42	return fmt.Sprintf("protocol: decode message type %d: %v", e.Type, e.Err)
43}
44
45func (e *DecodeFailure) Unwrap() error {
46	if e == nil {
47		return nil
48	}
49	return e.Err
50}