iggy_binary_protocol 0.11.1-edge.2

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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

// 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 crate::WireError;
use crate::WireIdentifier;
use crate::codec::{WireDecode, WireEncode};
use crate::primitives::identifier::WireName;
use crate::primitives::options::WireOptions;
use crate::requests::system::update_resource::{
    decode_optional_name, decode_resolved_blocks, encode_optional_name, encode_resolved_blocks,
    optional_name_size, resolved_blocks_size,
};
use bytes::BytesMut;

/// An `UpdateResource` on a topic after prepare: the rename extracted, the set
/// keys canonical in `explicit_options`, the reset keys resolved to their
/// defaults in `derived_options`.
///
/// Wire format:
/// ```text
/// [stream_id][topic_id][has_name:u8][name?][explicit_len:u32][explicit][derived_len:u32][derived]
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct UpdateTopicResolvedRequest {
    pub stream_id: WireIdentifier,
    pub topic_id: WireIdentifier,
    pub name: Option<WireName>,
    pub explicit_options: WireOptions,
    pub derived_options: WireOptions,
}

impl WireEncode for UpdateTopicResolvedRequest {
    fn encoded_size(&self) -> usize {
        self.stream_id.encoded_size()
            + self.topic_id.encoded_size()
            + optional_name_size(self.name.as_ref())
            + resolved_blocks_size(&self.explicit_options, &self.derived_options)
    }

    fn encode(&self, buf: &mut BytesMut) {
        self.stream_id.encode(buf);
        self.topic_id.encode(buf);
        encode_optional_name(self.name.as_ref(), buf);
        encode_resolved_blocks(&self.explicit_options, &self.derived_options, buf);
    }
}

impl WireDecode for UpdateTopicResolvedRequest {
    fn decode(buf: &[u8]) -> Result<(Self, usize), WireError> {
        let (stream_id, mut position) = WireIdentifier::decode(buf)?;
        let (topic_id, consumed) = WireIdentifier::decode(&buf[position..])?;
        position += consumed;
        let (name, consumed) = decode_optional_name(buf, position)?;
        position += consumed;
        let (explicit_options, derived_options) = decode_resolved_blocks(buf, position)?;
        Ok((
            Self {
                stream_id,
                topic_id,
                name,
                explicit_options,
                derived_options,
            },
            buf.len(),
        ))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::primitives::user_headers::encode_user_headers;

    #[test]
    fn given_resolved_patch_when_roundtripping_should_preserve_columns_and_provenance() {
        let request = UpdateTopicResolvedRequest {
            stream_id: WireIdentifier::numeric(1),
            topic_id: WireIdentifier::named("orders").unwrap(),
            name: Some(WireName::new("orders-v2").unwrap()),
            explicit_options: options(b"message_expiry", &7u64.to_le_bytes()),
            derived_options: options(b"max_topic_size", &u64::MAX.to_le_bytes()),
        };
        let bytes = request.to_bytes();
        assert_eq!(bytes.len(), request.encoded_size());
        assert_eq!(
            UpdateTopicResolvedRequest::decode_from(&bytes).unwrap(),
            request
        );
        for length in 0..bytes.len() {
            assert!(UpdateTopicResolvedRequest::decode(&bytes[..length]).is_err());
        }
    }

    fn options(key: &[u8], value: &[u8]) -> WireOptions {
        let mut buf = BytesMut::new();
        encode_user_headers(&[(2, key, 12, value)], &mut buf);
        WireOptions::from_bytes(buf.freeze()).unwrap()
    }
}