iggy_binary_protocol 0.11.0

Wire protocol types and codec for the Iggy binary protocol. Shared between server and SDK.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License.  You may obtain a copy of the License at
//
//   http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied.  See the License for the
// specific language governing permissions and limitations
// under the License.

use super::command::Command;
use thiserror::Error;

#[derive(Debug, Clone, Error, PartialEq, Eq)]
pub enum ConsensusError {
    #[error("invalid command: expected {expected:?}, found {found:?}")]
    InvalidCommand { expected: Command, found: Command },

    #[error("invalid size: expected {expected:?}, found {found:?}")]
    InvalidSize { expected: u32, found: u32 },

    #[error("invalid checksum")]
    InvalidChecksum,

    #[error(
        "{command:?}: header checksum {found:#034x} does not cover the frame (expected \
         {expected:#034x}){}",
        if *found == 0 {
            ". A zeroed checksum is the signature of a peer predating the frame seal, \
             which is a hard version break: replicas must be upgraded together, with the \
             cluster down"
        } else {
            ""
        }
    )]
    FrameChecksumMismatch {
        command: Command,
        expected: u128,
        found: u128,
    },

    #[error("invalid cluster ID")]
    InvalidCluster,

    #[error("invalid field: {0}")]
    InvalidField(String),

    // -- Reserved for future consensus validation --
    // These variants exist in the original iggy_common implementation
    // and will be used when the consensus crate migrates to this crate.
    #[error("parent_padding must be 0")]
    PrepareParentPaddingNonZero,

    #[error("request_checksum_padding must be 0")]
    PrepareRequestChecksumPaddingNonZero,

    #[error("command must be Commit")]
    CommitInvalidCommand,

    #[error("size must be 256, found {0}")]
    CommitInvalidSize(u32),

    #[error("command must be Reply")]
    ReplyInvalidCommand,

    #[error("request_checksum_padding must be 0")]
    ReplyRequestChecksumPaddingNonZero,

    #[error("context_padding must be 0")]
    ReplyContextPaddingNonZero,

    #[error("invalid bit pattern in header (enum discriminant out of range)")]
    InvalidBitPattern,

    // Consequence deliberately left out: `RequestHeader` reaches here too, and a
    // client frame is dropped without a reply rather than stalling a consensus
    // group. The plane-specific outcome belongs to the call site that logs it.
    // "Likely", not asserted: replica frames authenticate the byte (frame seal
    // or prepare identity) before this is raised, but a client `Request` has
    // neither checksum, so its byte stays unverifiable.
    #[error(
        "operation {operation:#04x} is not known to this build; a newer release likely added it"
    )]
    UnsupportedOperation { operation: u8 },

    #[error("client-bound command {0:?} cannot be dispatched on inbound path")]
    ClientBoundCommand(Command),
}