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

/*
** 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.
*/

#![deny(clippy::suspicious)]
#![deny(clippy::complexity)]
#![deny(clippy::perf)]
#![deny(clippy::style)]
#![deny(clippy::cargo)]
#![deny(clippy::items_after_statements)]
#![deny(clippy::missing_panics_doc)]
#![deny(clippy::uninlined_format_args)]
#![deny(clippy::unnecessary_semicolon)]
#![deny(clippy::unreadable_literal)]
#![deny(clippy::allow_attributes_without_reason)]
#![deny(clippy::panic)]
#![deny(clippy::partial_pub_fields)]
#![deny(clippy::redundant_test_prefix)]
//#![deny(clippy::undocumented_unsafe_blocks)]
//#![deny(missing_docs)]
#![allow(clippy::multiple_crate_versions, reason = "rpassword problem")]

//! # Introduction
//!
//! Iks is an XML parser library for [Jabber/XMPP](https://xmpp.org/)
//! and general XML processing applications. It aims to be easy to use,
//! fast, and usable in resource-constrained environments.
//!
//! Module architecture:
//! ```text
//!           +---------+
//!           |SaxParser|--\
//!           +---------+   \    +--------+    +------+    +--------+    +------+
//!                          \-->|Document|--->|Stream|--->|Xmpp    |--->|Xmpp  |
//! +-----+    +--------+        |Builder |    |Parser|    |Client  |    |Client|
//! |Arena|--->|Document|<------>|& Parser|    +------+    |Protocol|    +------+
//! +-----+    |& Cursor|        +--------+                +--------+
//!            +--------+
//!                 |             +-----+
//!                 v------------>|XPath|
//!                               +-----+
//! ```
//!
//! Arena: A compact and fast memory allocation arena for storing XML
//! element tree structs and character data. Not used directly by
//! the applications.
//!
//! Sax Parser: This fast and memory efficient parser is the core of
//! the Iksemel. Validates and processes byte streams and generates
//! XML elements.
//!
//! Document: Builds and queries XML element trees inside Arenas.
//!
//! Document Parser: Parses an XML byte stream into an XML element
//! tree structure.
//!
//! Stream Parser: Parses an XML byte stream into an XMPP Stream
//! with individual top level elements.
//!
//! XmppClientProtocol: A sans-io implementation of the XMPP client
//! stream protocol, including authentication and stanza handling.
//!
//! XmppClient: A complete client implementation using blocking-io
//! operations on top of the XmppClientProtocol.
//!

mod arena;
mod document;
mod entities;
mod parser;
#[cfg(feature = "xmpp")]
mod xmpp;
mod xpath;

pub const VERSION: &str = env!("CARGO_PKG_VERSION");

pub use arena::Arena;
pub use arena::ArenaStats;
pub use arena::NoMemory;

pub use parser::Location;
pub use parser::ParseError;
pub use parser::SaxElement;
pub use parser::SaxElements;
pub use parser::SaxParser;

pub use document::Ancestor;
pub use document::Attributes;
pub use document::Children;
pub use document::Cursor;
pub use document::DescendantOrSelf;
pub use document::Document;
pub use document::DocumentBuilder;
pub use document::DocumentParser;
pub use document::FollowingSibling;
pub use document::PrecedingSibling;
pub use document::SyncCursor;

#[cfg(feature = "xmpp")]
pub use xmpp::BadJid;
#[cfg(feature = "xmpp")]
pub use xmpp::Jid;
#[cfg(feature = "xmpp")]
pub use xmpp::StreamElement;
#[cfg(feature = "xmpp")]
pub use xmpp::StreamError;
#[cfg(feature = "xmpp")]
pub use xmpp::StreamParser;
#[cfg(feature = "xmpp")]
pub use xmpp::XmppClient;
#[cfg(feature = "xmpp")]
pub use xmpp::XmppClientBuilder;
#[cfg(feature = "xmpp")]
pub use xmpp::XmppClientError;
#[cfg(feature = "xmpp")]
pub use xmpp::XmppClientProtocol;
#[cfg(feature = "xmpp")]
pub use xmpp::constants::CLIENT_PORT as XMPP_CLIENT_PORT;
#[cfg(feature = "xmpp")]
pub use xmpp::constants::SERVER_PORT as XMPP_SERVER_PORT;

pub use xpath::XPath;