#xmpp #jid

jid

A crate which provides a Jid struct for Jabber IDs

24 releases

0.10.0 Aug 20, 2023
0.9.4 Jul 13, 2022
0.9.3 Mar 7, 2022
0.9.2 Jan 13, 2021
0.1.0 Feb 27, 2017

#332 in Network programming

Download history 106/week @ 2023-08-10 151/week @ 2023-08-17 147/week @ 2023-08-24 53/week @ 2023-08-31 111/week @ 2023-09-07 143/week @ 2023-09-14 92/week @ 2023-09-21 128/week @ 2023-09-28 91/week @ 2023-10-05 95/week @ 2023-10-12 129/week @ 2023-10-19 174/week @ 2023-10-26 160/week @ 2023-11-02 146/week @ 2023-11-09 125/week @ 2023-11-16 123/week @ 2023-11-23

594 downloads per month
Used in 11 crates (3 directly)

MPL-2.0 license

61KB
1K SLoC

jid

What's this?

A crate which provides a struct Jid for Jabber IDs. It's used in xmpp-rs but other XMPP libraries can of course use this.

What license is it under?

MPL-2.0 or later, see the LICENSE file.

Notes

This library does not yet implement RFC7622.


lib.rs:

Represents XMPP addresses, also known as JabberIDs (JIDs) for the XMPP protocol. A [Jid] can have between one and three parts in the form node@domain/resource:

  • the (optional) node part designates a specific account/service on a server, for example username@server.com
  • the domain part designates a server, for example irc.jabberfr.org
  • the (optional) resource part designates a more specific client, such as a participant in a groupchat (jabberfr@chat.jabberfr.org/user) or a specific client device associated with an account (user@example.com/dino)

The [Jid] enum can be one of two variants, containing a more specific type:

  • BareJid (Jid::Bare variant): a JID without a resource
  • FullJid (Jid::Full variant): a JID with a resource

Jids as per the XMPP protocol only ever contain valid UTF-8. However, creating any form of Jid can fail in one of the following cases:

  • wrong syntax: creating a Jid with an empty (yet declared) node or resource part, such as @example.com or user@example.com/
  • stringprep error: some characters were invalid according to the stringprep algorithm, such as mixing left-to-write and right-to-left characters

Dependencies

~3MB
~133K SLoC