xmpp_parsers/
stream_limits.rs

1// Copyright (c) 2024 Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
2//
3// This Source Code Form is subject to the terms of the Mozilla Public
4// License, v. 2.0. If a copy of the MPL was not distributed with this
5// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6
7use xso::{AsXml, FromXml};
8
9use crate::ns;
10use core::num::NonZeroU32;
11
12/// Advertises limits on this stream.
13#[derive(FromXml, AsXml, Debug, Clone, PartialEq)]
14#[xml(namespace = ns::STREAM_LIMITS, name = "limits")]
15pub struct Limits {
16    /// Maximum size of any first-level stream elements (including stanzas), in bytes the
17    /// announcing entity is willing to accept.
18    // TODO: Replace that with a direct u32 once xso supports that.
19    #[xml(child(default))]
20    pub max_bytes: Option<MaxBytes>,
21
22    /// Number of seconds without any traffic from the iniating entity after which the server may
23    /// consider the stream idle, and either perform liveness checks or terminate the stream.
24    // TODO: Replace that with a direct u32 once xso supports that.
25    #[xml(child(default))]
26    pub idle_seconds: Option<IdleSeconds>,
27}
28
29/// Maximum size of any first-level stream elements (including stanzas), in bytes the
30/// announcing entity is willing to accept.
31#[derive(FromXml, AsXml, Debug, Clone, PartialEq)]
32#[xml(namespace = ns::STREAM_LIMITS, name = "max-bytes")]
33pub struct MaxBytes {
34    /// The number of bytes.
35    #[xml(text)]
36    pub value: NonZeroU32,
37}
38
39/// Number of seconds without any traffic from the iniating entity after which the server may
40/// consider the stream idle, and either perform liveness checks or terminate the stream.
41#[derive(FromXml, AsXml, Debug, Clone, PartialEq)]
42#[xml(namespace = ns::STREAM_LIMITS, name = "idle-seconds")]
43pub struct IdleSeconds {
44    /// The number of seconds.
45    #[xml(text)]
46    pub value: NonZeroU32,
47}
48
49#[cfg(test)]
50mod tests {
51    use super::*;
52    use minidom::Element;
53
54    #[test]
55    fn test_size() {
56        assert_size!(Limits, 8);
57        assert_size!(MaxBytes, 4);
58        assert_size!(IdleSeconds, 4);
59    }
60
61    #[test]
62    fn test_simple() {
63        let elem: Element =
64            "<limits xmlns='urn:xmpp:stream-limits:0'><max-bytes>262144</max-bytes></limits>"
65                .parse()
66                .unwrap();
67        let limits = Limits::try_from(elem).unwrap();
68        assert_eq!(
69            limits.max_bytes.unwrap().value,
70            NonZeroU32::new(262144).unwrap()
71        );
72        assert!(limits.idle_seconds.is_none());
73    }
74}
xmpp_parsers/stream_limits.rs

xmpp_parsers/
stream_limits.rs
