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