kacrab 0.2.0

A Kafka client for Rust, built from the protocol up.
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

//! Broker API version capabilities discovered from `ApiVersions`.

use std::collections::HashMap;

use kacrab_protocol::{
    generated::{ApiKey, ApiVersionsResponseData},
    version::{ApiVersionRange, client_api_info, resolve_api_version},
};

/// Broker API version capabilities discovered by `ApiVersions`.
#[derive(Debug, Clone, PartialEq, Eq, Default)]
pub struct BrokerCapabilities {
    versions: HashMap<i16, ApiVersionRange>,
}

impl BrokerCapabilities {
    /// Build broker capabilities from an `ApiVersionsResponse`.
    #[must_use]
    pub fn from_response(response: &ApiVersionsResponseData) -> Self {
        let versions = response
            .api_keys
            .iter()
            .map(|api| {
                (
                    api.api_key,
                    ApiVersionRange {
                        min_version: api.min_version,
                        max_version: api.max_version,
                    },
                )
            })
            .collect();
        Self { versions }
    }

    /// Resolve the highest mutually supported version for an API.
    #[must_use]
    pub fn version_for(&self, api_key: ApiKey) -> Option<i16> {
        let broker = *self.versions.get(&(api_key as i16))?;
        resolve_api_version(api_key as i16, broker)
    }

    /// Resolve the highest mutually supported version for an API, capped by
    /// the caller's maximum acceptable version.
    #[must_use]
    pub fn version_for_limit(&self, api_key: ApiKey, max_version: i16) -> Option<i16> {
        let mut broker = *self.versions.get(&(api_key as i16))?;
        let client = client_api_info(api_key);
        broker.max_version = broker.max_version.min(max_version).min(client.max_version);
        resolve_api_version(api_key as i16, broker)
    }
}

#[cfg(test)]
mod tests {
    #![allow(
        clippy::expect_used,
        clippy::missing_assert_message,
        clippy::unwrap_used,
        reason = "Unit test fixtures fail fastest with contextual unwrap/expect calls."
    )]

    use kacrab_protocol::generated::{ApiKey, ApiVersion, ApiVersionsResponseData};

    use super::BrokerCapabilities;

    #[test]
    fn capabilities_resolve_supported_version_and_missing_api() {
        let capabilities = BrokerCapabilities::from_response(&ApiVersionsResponseData {
            api_keys: vec![ApiVersion {
                api_key: ApiKey::Metadata as i16,
                min_version: 0,
                max_version: 12,
                _unknown_tagged_fields: Vec::new(),
            }],
            ..ApiVersionsResponseData::default()
        });

        assert_eq!(capabilities.version_for(ApiKey::Metadata), Some(12));
        assert_eq!(capabilities.version_for_limit(ApiKey::Metadata, 8), Some(8));
        assert_eq!(capabilities.version_for(ApiKey::Produce), None);
    }
}