A type-safe Rust XMPP library.
Find a file
Jonas Schäfer 6ef8dbefa3 parsers: use Error type from xso
This is a large change and as such, it needs good motivation. Let me
remind you of the ultimate goal: we want a derive macro which allows us
to FromXml/IntoXml, and that derive macro should be usable from
`xmpp_parsers` and other crates.

For that, any code generated by the derive macro mustn't depend on any
code in the `xmpp_parsers` crate, because you cannot name the crate you
are in portably (`xmpp_parsers::..` wouldn't resolve within
`xmpp_parsers`, and `crate::..` would point at other crates if the macro
was used in other crates).

We also want to interoperate with code already implementing
`TryFrom<Element>` and `Into<Element>` on structs. This ultimately
requires that we have an error type which is shared by the two
implementations and that error type must be declared in the `xso` crate
to be usable by the macros.

Thus, we port the error type over to use the type declared in `xso`.

This changes the structure of the error type greatly; I do not think
that `xso` should have to know about all the different types we are
parsing there and they don't deserve special treatment. Wrapping them in
a `Box<dyn ..>` seems more appropriate.
2024-06-23 09:40:52 +02:00
.forgejo/workflows CI: display rustfmt version 2024-06-18 20:38:42 +02:00
jid Add more specific into_* conversion functions to specific JID subtypes 2024-05-14 17:53:53 +02:00
minidom xso: create library for streamed XML parsing 2024-06-18 16:54:11 +02:00
parsers parsers: use Error type from xso 2024-06-23 09:40:52 +02:00
sasl Fix typos across the codebase (thanks codespell!) 2024-05-14 05:46:02 +00:00
tokio-xmpp Revert "tokio-xmpp: rustfmt pass in examples" 2024-06-18 20:32:46 +02:00
xmpp Ignore missing disco#info feature in disco#info responses 2024-06-16 10:52:51 +02:00
xso parsers: use Error type from xso 2024-06-23 09:40:52 +02:00
.gitea Support Github Actions (for a migration to forgejo) 2023-12-03 14:20:51 +00:00
.github Deny warnings in github/gitea/forgejo CI and act local runner 2024-01-21 13:55:39 +01:00
.gitignore Hello world! 2019-03-21 18:43:27 +01:00
.gitlab-ci.yml CI: display rustfmt version 2024-06-18 20:38:42 +02:00
Cargo.toml parsers: add streamable parsing 2024-06-18 16:54:11 +02:00
CODE_OF_CONDUCT.md Code of Conduct 2024-01-21 21:50:31 +01:00
CONTRIBUTING.md CONTRIBUTING: Split in categories 2024-02-02 22:26:00 +01:00
LICENSE Readd global LICENSE file 2020-02-25 22:13:34 +01:00
README.md CONTRIBUTING: Split in categories 2024-02-02 22:26:00 +01:00

xmpp-rs

What's this?

A very much WIP set of rust XMPP library with the goals of being type-safe and well-tested.

  • xmpp-rs provides a high-level API for the protocol. You shouldn't need to know about the protocol to use it.
  • tokio-xmpp is a lower-level library that handles the XMPP stream(s).
  • xmpp-parsers parses XML into Rust and back.
  • minidom is a DOM library quite specific for XMPP
  • jid is a Jid parsing library.

Contact

There is an XMPP MUC for the discussion of this library, feel free to join! :)

chat@xmpp.rs

Community

A Code of Conduct is available as CODE_OF_CONDUCT.md in the repository for the well-being of the community. Please refer to it in case of a possible conflict in any of the xmpp-rs venues (channel, forge, etc.).

License

Mozilla Public License 2 (MPL2). See the LICENSE file.

Building

Dependencies should be provided by crates if you use the default features. If you use tokio-xmpp's tls-native feature you will need an ssl library (openssl, libressl, etc.).

cargo build

The various features available should be explained in the crates themselves.

Contributing

Thank you for your interest in the project!

Contributing rules are available as CONTRIBUTING.md in the repository.