1//! A crate parsing common XMPP elements into Rust structures.
2//!
3//! Each module implements the [`TryFrom<Element>`] trait, which takes a
4//! minidom [`Element`] and returns a `Result` whose value is `Ok` if the
5//! element parsed correctly, `Err(error::Error)` otherwise.
6//!
7//! The returned structure can be manipuled as any Rust structure, with each
8//! field being public. You can also create the same structure manually, with
9//! some having `new()` and `with_*()` helper methods to create them.
10//!
11//! Once you are happy with your structure, you can serialise it back to an
12//! [`Element`], using either `From` or `Into<Element>`, which give you what
13//! you want to be sending on the wire.
14//!
15//! [`TryFrom<Element>`]: ../try_from/trait.TryFrom.html
16//! [`Element`]: ../minidom/element/struct.Element.html
17
18// Copyright (c) 2017-2018 Emmanuel Gil Peyrot <linkmauve@linkmauve.fr>
19// Copyright (c) 2017 Maxime “pep” Buquet <pep+code@bouah.net>
20//
21// This Source Code Form is subject to the terms of the Mozilla Public
22// License, v. 2.0. If a copy of the MPL was not distributed with this
23// file, You can obtain one at http://mozilla.org/MPL/2.0/.
24
25#![deny(missing_docs)]
26
27pub use minidom::Element;
28
29/// Error type returned by every parser on failure.
30pub mod error;
31/// XML namespace definitions used through XMPP.
32pub mod ns;
33
34/// Various helpers.
35mod helpers;
36/// Helper macros to parse and serialise more easily.
37#[macro_use]
38mod macros;
39
40#[cfg(test)]
41/// Namespace-aware comparison for tests
42mod compare_elements;
43
44/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
45pub mod bind;
46/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
47pub mod iq;
48/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
49pub mod message;
50/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
51pub mod presence;
52/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
53pub mod sasl;
54/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
55pub mod stanza_error;
56/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
57pub mod stream;
58
59/// RFC 6121: Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence
60pub mod roster;
61
62/// RFC 7395: An Extensible Messaging and Presence Protocol (XMPP) Subprotocol for WebSocket
63pub mod websocket;
64
65/// XEP-0004: Data Forms
66pub mod data_forms;
67
68/// XEP-0030: Service Discovery
69pub mod disco;
70
71/// XEP-0045: Multi-User Chat
72pub mod muc;
73
74/// XEP-0047: In-Band Bytestreams
75pub mod ibb;
76
77/// XEP-0048: Bookmarks
78pub mod bookmarks;
79
80/// XEP-0059: Result Set Management
81pub mod rsm;
82
83/// XEP-0060: Publish-Subscribe
84pub mod pubsub;
85
86/// XEP-0077: In-Band Registration
87pub mod ibr;
88
89/// XEP-0082: XMPP Date and Time Profiles
90pub mod date;
91
92/// XEP-0085: Chat State Notifications
93pub mod chatstates;
94
95/// XEP-0092: Software Version
96pub mod version;
97
98/// XEP-0107: User Mood
99pub mod mood;
100
101/// XEP-0114: Jabber Component Protocol
102pub mod component;
103
104/// XEP-0115: Entity Capabilities
105pub mod caps;
106
107/// XEP-0166: Jingle
108pub mod jingle;
109
110/// XEP-0172: User Nickname
111pub mod nick;
112
113/// XEP-0184: Message Delivery Receipts
114pub mod receipts;
115
116/// XEP-0191: Blocking Command
117pub mod blocking;
118
119/// XEP-0198: Stream Management
120pub mod sm;
121
122/// XEP-0199: XMPP Ping
123pub mod ping;
124
125/// XEP-0203: Delayed Delivery
126pub mod delay;
127
128/// XEP-0221: Data Forms Media Element
129pub mod media_element;
130
131/// XEP-0224: Attention
132pub mod attention;
133
134/// XEP-0234: Jingle File Transfer
135pub mod jingle_ft;
136
137/// XEP-0260: Jingle SOCKS5 Bytestreams Transport Method
138pub mod jingle_s5b;
139
140/// XEP-0261: Jingle In-Band Bytestreams Transport Method
141pub mod jingle_ibb;
142
143/// XEP-0297: Stanza Forwarding
144pub mod forwarding;
145
146/// XEP-0300: Use of Cryptographic Hash Functions in XMPP
147pub mod hashes;
148
149/// XEP-0308: Last Message Correction
150pub mod message_correct;
151
152/// XEP-0313: Message Archive Management
153pub mod mam;
154
155/// XEP-0319: Last User Interaction in Presence
156pub mod idle;
157
158/// XEP-0353: Jingle Message Initiation
159pub mod jingle_message;
160
161/// XEP-0359: Unique and Stable Stanza IDs
162pub mod stanza_id;
163
164/// XEP-0380: Explicit Message Encryption
165pub mod eme;
166
167/// XEP-0390: Entity Capabilities 2.0
168pub mod ecaps2;