lib.rs

  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 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
 25extern crate minidom;
 26extern crate jid;
 27extern crate base64;
 28extern crate digest;
 29extern crate sha_1;
 30extern crate sha2;
 31extern crate sha3;
 32extern crate blake2;
 33extern crate chrono;
 34extern crate try_from;
 35
 36/// Error type returned by every parser on failure.
 37pub mod error;
 38/// XML namespace definitions used through XMPP.
 39pub mod ns;
 40/// Helper macros to parse and serialise more easily.
 41#[macro_use]
 42pub mod macros;
 43
 44#[cfg(test)]
 45/// Namespace-aware comparison for tests
 46mod compare_elements;
 47
 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 iq;
 54/// RFC 6120: Extensible Messaging and Presence Protocol (XMPP): Core
 55pub mod stanza_error;
 56
 57/// RFC 6121: Extensible Messaging and Presence Protocol (XMPP): Instant Messaging and Presence
 58pub mod roster;
 59
 60/// XEP-0004: Data Forms
 61pub mod data_forms;
 62
 63/// XEP-0030: Service Discovery
 64pub mod disco;
 65
 66/// XEP-0045: Multi-User Chat
 67pub mod muc;
 68
 69/// XEP-0047: In-Band Bytestreams
 70pub mod ibb;
 71
 72/// XEP-0059: Result Set Management
 73pub mod rsm;
 74
 75/// XEP-0060: Publish-Subscribe
 76pub mod pubsub;
 77
 78/// XEP-0077: In-Band Registration
 79pub mod ibr;
 80
 81/// XEP-0082: XMPP Date and Time Profiles
 82pub mod date;
 83
 84/// XEP-0085: Chat State Notifications
 85pub mod chatstates;
 86
 87/// XEP-0092: Software Version
 88pub mod version;
 89
 90/// XEP-0115: Entity Capabilities
 91pub mod caps;
 92
 93/// XEP-0166: Jingle
 94pub mod jingle;
 95
 96/// XEP-0184: Message Delivery Receipts
 97pub mod receipts;
 98
 99/// XEP-0191: Blocking Command
100pub mod blocking;
101
102/// XEP-0199: XMPP Ping
103pub mod ping;
104
105/// XEP-0203: Delayed Delivery
106pub mod delay;
107
108/// XEP-0221: Data Forms Media Element
109pub mod media_element;
110
111/// XEP-0224: Attention
112pub mod attention;
113
114/// XEP-0234: Jingle File Transfer
115pub mod jingle_ft;
116
117/// XEP-0260: Jingle SOCKS5 Bytestreams Transport Method
118pub mod jingle_s5b;
119
120/// XEP-0261: Jingle In-Band Bytestreams Transport Method
121pub mod jingle_ibb;
122
123/// XEP-0297: Stanza Forwarding
124pub mod forwarding;
125
126/// XEP-0300: Use of Cryptographic Hash Functions in XMPP
127pub mod hashes;
128
129/// XEP-0308: Last Message Correction
130pub mod message_correct;
131
132/// XEP-0313: Message Archive Management
133pub mod mam;
134
135/// XEP-0319: Last User Interaction in Presence
136pub mod idle;
137
138/// XEP-0353: Jingle Message Initiation
139pub mod jingle_message;
140
141/// XEP-0359: Unique and Stable Stanza IDs
142pub mod stanza_id;
143
144/// XEP-0380: Explicit Message Encryption
145pub mod eme;
146
147/// XEP-0390: Entity Capabilities 2.0
148pub mod ecaps2;