tokio_xmpp/
lib.rs

1//! Low-level [XMPP](https://xmpp.org/) decentralized instant messaging & social networking implementation with asynchronous I/O using [tokio](https://tokio.rs/).
2//!
3//! For an easier, batteries-included experience, try the [xmpp crate](https://docs.rs/xmpp).
4//!
5//! # Getting started
6//!
7//! In most cases, you want to start with a [`Client`], that will connect to a server over TCP/IP with StartTLS encryption. Then, you can build an event loop by calling the client's `next` method repeatedly. You can find a more complete example in the [examples/echo_bot.rs](https://gitlab.com/xmpp-rs/xmpp-rs/-/blob/main/tokio-xmpp/examples/echo_bot.rs) file in the repository.
8//!
9//! # Features
10//!
11//! This library is not feature-complete yet. Here's a quick overview of the feature set.
12//!
13//! Supported implementations:
14//! - [x] Clients
15//! - [x] Components
16//! - [ ] Servers
17//!
18//! Supported transports:
19//! - [x] Plaintext TCP (IPv4/IPv6)
20//! - [x] StartTLS TCP (IPv4/IPv6 with [happy eyeballs](https://en.wikipedia.org/wiki/Happy_Eyeballs) support)
21//! - [x] Custom connectors via the [`connect::ServerConnector`] trait
22//! - [ ] Websockets
23//! - [ ] BOSH
24//!
25//! # More information
26//!
27//! You can find more information on our website [xmpp.rs](https://xmpp.rs/) or by joining our chatroom [chat@xmpp.rs](xmpp:chat@xmpp.rs?join).
28
29#![deny(unsafe_code, missing_docs, bare_trait_objects)]
30#![cfg_attr(docsrs, feature(doc_auto_cfg))]
31
32#[cfg(all(
33    not(xmpprs_doc_build),
34    not(doc),
35    feature = "tls-native",
36    feature = "tls-rust"
37))]
38compile_error!("Both tls-native and tls-rust features can't be enabled at the same time.");
39
40#[cfg(all(
41    feature = "starttls",
42    not(feature = "tls-native"),
43    not(feature = "tls-rust")
44))]
45compile_error!(
46    "when starttls feature enabled one of tls-native and tls-rust features must be enabled."
47);
48
49extern crate alloc;
50
51pub use parsers::{jid, minidom};
52pub use xmpp_parsers as parsers;
53
54mod client;
55#[cfg(feature = "insecure-tcp")]
56mod component;
57pub mod connect;
58/// Detailed error types
59pub mod error;
60mod event;
61pub mod stanzastream;
62pub mod xmlstream;
63
64#[doc(inline)]
65/// Generic tokio_xmpp Error
66pub use crate::error::Error;
67pub use client::{Client, IqFailure, IqRequest, IqResponse, IqResponseToken};
68#[cfg(feature = "insecure-tcp")]
69pub use component::Component;
70pub use event::{Event, Stanza};
71
72#[cfg(test)]
73mod tests {
74    #[test]
75    fn reexports() {
76        #[allow(unused_imports)]
77        use crate::jid;
78        #[allow(unused_imports)]
79        use crate::minidom;
80        #[allow(unused_imports)]
81        use crate::parsers;
82    }
83}
84
85// Re-export for debug purposes
86pub use xso::asxml::PrintRawXml;
tokio_xmpp/lib.rs

tokio_xmpp/
lib.rs
