dyniak 1.4.1

Riak-compatible protocol surface (HTTP + PBC) and storage bridge for the Dynomite Rust port
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
96
97
98
99
100
101
102
103

//! Riak Protocol Buffers transport.
//!
//! # Wire format
//!
//! Riak frames every Protocol-Buffers request and response identically:
//!
//! ```text
//!   +----------------+--------+--------------------------+
//!   | length (u32 BE)| code u8|       protobuf body      |
//!   +----------------+--------+--------------------------+
//!   |    4 bytes     | 1 byte |    `length - 1` bytes    |
//! ```
//!
//! `length` is the number of bytes that follow the length prefix and
//! therefore covers both the message code byte and the protobuf body.
//! The minimum legal value is `1` (a body-less request such as
//! `RpbPingReq`).
//!
//! Numerical message codes are stable across Riak versions; this
//! module pins the subset the v0.0.1 slice supports
//! ([`messages::MessageCode`]). Codes outside the supported set
//! produce [`crate::error::RiakError::UnknownMessageCode`].
//!
//! # Encoding
//!
//! All PBC bodies are encoded as protobuf via
//! [`dyn_encoding::ProtobufCodec`]. The codec is built once via
//! [`codec_registry`] and shared across connections. The
//! `dyn-encoding` registry is keyed by content-type, so the HTTP
//! gateway registers JSON and CBOR codecs alongside this
//! protobuf codec without touching the PBC path.

pub mod codec;
pub mod datatypes;
pub mod framer;
pub mod mapreduce;
pub mod messages;

pub use crate::proto::pb::codec::{codec_registry, PbCodecBundle, PBC_CONTENT_TYPE};
pub use crate::proto::pb::framer::{read_frame, write_frame, Frame, MAX_FRAME_LEN};
pub use crate::proto::pb::messages::{
    MessageCode, RpbDelReq, RpbErrorResp, RpbGetReq, RpbGetResp, RpbPingReq, RpbPingResp,
    RpbPutReq, RpbPutResp,
};

// Nested content message and link type -- PBC RpbContent slice.
// Re-exported below the prior block so parallel branches do not
// conflict.
pub use crate::proto::pb::messages::{RpbContent, RpbLink};

// New message types added by the v0.0.2 PBC ops slice. Re-exported
// below the existing block so parallel branches do not conflict.
pub use crate::proto::pb::messages::{
    RpbBucketProps, RpbGetBucketReq, RpbGetBucketResp, RpbGetServerInfoResp, RpbIndexReq,
    RpbIndexResp, RpbListBucketsReq, RpbListBucketsResp, RpbListKeysReq, RpbListKeysResp, RpbPair,
    RpbServerInfoReq, RpbSetBucketReq, RpbSetBucketResp, INDEX_QUERY_TYPE_EQ,
    INDEX_QUERY_TYPE_RANGE,
};

// CRDT operations -- v0.0.3 slice. Re-exported below the existing
// blocks so parallel branches do not conflict.
pub use crate::proto::pb::datatypes::{
    CounterOp, DtFetchReq, DtFetchResp, DtOp, DtUpdateReq, DtUpdateResp, DtValue, GSetOp, HllOp,
    SetOp, DATA_TYPE_COUNTER, DATA_TYPE_GSET, DATA_TYPE_HLL, DATA_TYPE_MAP, DATA_TYPE_SET,
    DT_FETCH_REQ_CODE, DT_FETCH_RESP_CODE, DT_UPDATE_REQ_CODE, DT_UPDATE_RESP_CODE,
};
// MapReduce ops added by the v0.0.3 slice. Re-exported below the
// previous block so parallel branches do not conflict.
pub use crate::proto::pb::mapreduce::{RpbMapRedReq, RpbMapRedResp};

// Map and HyperLogLog wire types -- second CRDT slice. Re-exported
// below the prior block so parallel branches do not conflict.
pub use crate::proto::pb::datatypes::{
    FlagOp, HllValue, MapEntry, MapField, MapOp, MapUpdate, MapValue, RegisterOp, ScalarOp,
    ScalarValue, MAP_FIELD_TYPE_COUNTER, MAP_FIELD_TYPE_FLAG, MAP_FIELD_TYPE_MAP,
    MAP_FIELD_TYPE_REGISTER, MAP_FIELD_TYPE_SET,
};

// Cluster admin extension messages -- v0.0.4 admin slice. The
// type set covers the five PBC pairs invoked by `dyn-admin`'s
// cluster-list / cluster-join / cluster-leave / cluster-plan /
// cluster-commit subcommands. Re-exported below the prior block
// so parallel branches do not conflict.
pub use crate::proto::pb::messages::{
    DynRpbClusterCommitReq, DynRpbClusterCommitResp, DynRpbClusterJoinReq, DynRpbClusterJoinResp,
    DynRpbClusterLeaveReq, DynRpbClusterLeaveResp, DynRpbClusterPlanReq, DynRpbClusterPlanResp,
    DynRpbListPeersReq, DynRpbListPeersResp, DynRpbPeerInfo, DynRpbStagedChange,
    DYN_STAGED_CHANGE_ADD, DYN_STAGED_CHANGE_REMOVE,
};

// AAE-status admin extension messages -- AAE R5 slice. New
// PBC ops 220 / 221 carrying the AAE worker's snapshot.
pub use crate::proto::pb::messages::{
    DynRpbAaePeerStatus, DynRpbAaeStatusReq, DynRpbAaeStatusResp,
};

// Bucket-property selectors -- bucketonly keyfun and walk-N-
// successors replication slice. Re-exported below the prior block
// so parallel branches do not conflict.
pub use crate::proto::pb::messages::{
    CHASH_KEYFUN_BUCKETONLY, CHASH_KEYFUN_CUSTOM, CHASH_KEYFUN_STD,
    REPLICATION_STRATEGY_SUCCESSORS, REPLICATION_STRATEGY_TOPOLOGY,
};