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

// 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 std::borrow::Cow;

/// Protocol-local error type for wire format encode/decode failures.
///
/// Intentionally decoupled from `IggyError` to keep the protocol crate
/// free of domain dependencies. Conversion to `IggyError` happens at
/// the boundary (SDK / server).
#[derive(Debug, Clone, PartialEq, Eq, thiserror::Error)]
pub enum WireError {
    #[error("unexpected end of buffer at offset {offset}: need {need} bytes, have {have}")]
    UnexpectedEof {
        offset: usize,
        need: usize,
        have: usize,
    },

    #[error("invalid utf-8 at offset {offset}")]
    InvalidUtf8 { offset: usize },

    #[error("unknown command code: {0}")]
    UnknownCommand(u32),

    #[error("unknown discriminant {value} for {type_name} at offset {offset}")]
    UnknownDiscriminant {
        type_name: &'static str,
        value: u8,
        offset: usize,
    },

    #[error("payload too large: {size} bytes, max {max}")]
    PayloadTooLarge { size: usize, max: usize },

    #[error("validation failed: {0}")]
    Validation(Cow<'static, str>),

    #[error(
        "invalid batch checksum: stored {stored}, computed {computed}, base offset {base_offset}"
    )]
    InvalidBatchChecksum {
        stored: u64,
        computed: u64,
        base_offset: u64,
    },

    #[error("invalid message checksum: stored {stored}, computed {computed}, offset {offset}")]
    InvalidMessageChecksum {
        stored: u64,
        computed: u64,
        offset: u64,
    },

    #[error("message timestamp delta {0} exceeds the batch maximum")]
    InvalidMessageTimestampDelta(u64),
}