iggy_binary_protocol 0.10.1-edge.1

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

// 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.

//! VSR (Viewstamped Replication) consensus wire types.
//!
//! All headers are exactly 256 bytes with `#[repr(C)]` layout. Size is
//! enforced at compile time. Deserialization is a pointer cast (zero-copy)
//! via `bytemuck::try_from_bytes`.
//!
//! ## Client-facing
//! - [`RequestHeader`] - client -> primary
//! - [`ReplyHeader`] - primary -> client
//! - [`GenericHeader`] - type-erased envelope for dispatch
//!
//! ## Replication (server-to-server)
//! - [`PrepareHeader`] - primary -> replicas (replicate operation)
//! - [`PrepareOkHeader`] - replica -> primary (acknowledge)
//! - [`CommitHeader`] - primary -> replicas (commit, header-only)
//!
//! ## View change (server-to-server)
//! - [`StartViewChangeHeader`] - replica suspects primary failure (header-only)
//! - [`DoViewChangeHeader`] - replica -> primary candidate (header-only)
//! - [`StartViewHeader`] - new primary -> all replicas (header-only)
//!
//! ## Message wrapper
//! - [`message::Message`] - typed consensus message wrapper over request or response backing

mod command;
mod error;
mod header;
// iobuf was moved here verbatim from the former `core/iobuf` crate. Its
// implementation is intentionally untouched for rc2; the existing lints
// predate the move and are tracked as tech debt for a 0.9.x cleanup pass.
#[allow(
    private_interfaces,
    clippy::missing_errors_doc,
    clippy::missing_panics_doc,
    clippy::must_use_candidate,
    clippy::return_self_not_must_use,
    clippy::missing_const_for_fn,
    clippy::non_send_fields_in_send_ty,
    clippy::use_self
)]
pub mod iobuf;
pub mod message;
mod operation;

pub use command::Command2;
pub use error::ConsensusError;
pub use header::{
    CommitHeader, ConsensusHeader, DoViewChangeHeader, EvictionHeader, EvictionReason,
    GenericHeader, HEADER_SIZE, PrepareHeader, PrepareOkHeader, ReplyHeader, RequestHeader,
    SIZE_FIELD_OFFSET, StartViewChangeHeader, StartViewHeader, read_size_field,
};
pub use message::{
    ConsensusMessage, FragmentedBacking, MESSAGE_ALIGN, Message, MessageBacking, MessageBag,
    MutableBacking, RequestBacking, RequestBackingKind, ResponseBacking, ResponseBackingKind,
};
pub use operation::Operation;