iks 0.7.0

Fast, easy to use XML parser library for Jabber/XMPP and general XML processing
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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

/*
** This file is a part of Iksemel (XML parser for Jabber/XMPP)
** Copyright (C) 2000-2025 Gurer Ozen
**
** Iksemel is free software: you can redistribute it and/or modify it
** under the terms of the GNU Lesser General Public License as
** published by the Free Software Foundation, either version 3 of
** the License, or (at your option) any later version.
*/

mod error;

use crate::Document;
use crate::DocumentBuilder;
use crate::ParseError;
use crate::SaxElement;
use crate::SaxParser;

use super::constants::*;
pub use error::StreamError;

pub enum StreamElement {
    Element(Document),
    End,
}

pub struct StreamElements<'a> {
    parser: &'a mut StreamParser,
    bytes: &'a [u8],
    bytes_parsed: usize,
}

impl<'a> StreamElements<'a> {
    pub fn new(parser: &'a mut StreamParser, bytes: &'a [u8]) -> Self {
        Self {
            parser,
            bytes,
            bytes_parsed: 0,
        }
    }

    pub fn next(&mut self) -> Option<Result<StreamElement, StreamError>> {
        if self.bytes_parsed >= self.bytes.len() {
            return None;
        }
        match self.parser.parse_bytes(&self.bytes[self.bytes_parsed..]) {
            Ok(Some((element, bytes))) => {
                self.bytes_parsed += bytes;
                Some(Ok(element))
            }
            Ok(None) => {
                self.bytes_parsed = self.bytes.len();
                None
            }
            Err(err) => Some(Err(err.into())),
        }
    }
}

pub struct StreamParser {
    sax_parser: SaxParser,
    builder: DocumentBuilder,
    level: usize,
}

impl StreamParser {
    pub fn new() -> Self {
        Self {
            sax_parser: SaxParser::new(),
            builder: DocumentBuilder::new(),
            level: 0,
        }
    }

    pub fn reset(&mut self) {
        self.sax_parser.reset();
        self.builder.take();
        self.level = 0;
    }

    pub fn elements<'a>(&'a mut self, bytes: &'a [u8]) -> StreamElements<'a> {
        StreamElements::new(self, bytes)
    }

    pub fn parse_bytes(
        &mut self,
        bytes: &[u8],
    ) -> Result<Option<(StreamElement, usize)>, ParseError> {
        let mut bytes_parsed = 0;
        while bytes_parsed < bytes.len() {
            let sax_element = match self.sax_parser.parse_bytes(&bytes[bytes_parsed..]) {
                Ok(Some((element, bytes))) => {
                    bytes_parsed += bytes;
                    element
                }
                Ok(None) => {
                    return Ok(None);
                }
                Err(err) => return Err(err),
            };
            match sax_element {
                SaxElement::StartTag(_) => {
                    self.level += 1;
                }
                SaxElement::StartTagEmpty => {
                    self.level -= 1;
                }
                SaxElement::EndTag(name) => {
                    if self.level == 0 && name == STREAM_TAG {
                        return Ok(Some((StreamElement::End, bytes_parsed)));
                    }
                    self.level -= 1;
                }
                _ => {}
            }
            self.builder.append_element(&sax_element)?;
            match sax_element {
                SaxElement::StartTagContent => {
                    if self.level == 1
                        && self
                            .builder
                            .peek()
                            .is_some_and(|doc| doc.root().name() == STREAM_TAG)
                        && let Some(doc) = self.builder.take()
                    {
                        self.level = 0;
                        return Ok(Some((StreamElement::Element(doc), bytes_parsed)));
                    }
                }
                SaxElement::EndTag(_) | SaxElement::StartTagEmpty => {
                    if self.level == 0
                        && let Some(doc) = self.builder.take()
                    {
                        return Ok(Some((StreamElement::Element(doc), bytes_parsed)));
                    }
                }
                _ => {}
            }
        }
        Ok(None)
    }
}

impl Default for StreamParser {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests;