#xmpp #protocols #struct #part #node #bare #jabber-id

jid

A crate which provides a Jid struct for Jabber IDs

26 releases

0.12.0 Feb 24, 2025
0.11.1 Jul 23, 2024
0.10.0 Aug 20, 2023
0.9.4 Jul 13, 2022
0.1.0 Feb 27, 2017

#163 in Network programming

Download history 38/week @ 2024-11-25 44/week @ 2024-12-02 114/week @ 2024-12-09 111/week @ 2024-12-16 5/week @ 2024-12-23 109/week @ 2024-12-30 110/week @ 2025-01-06 116/week @ 2025-01-13 148/week @ 2025-01-20 85/week @ 2025-01-27 267/week @ 2025-02-03 237/week @ 2025-02-10 247/week @ 2025-02-17 1235/week @ 2025-02-24 568/week @ 2025-03-03 427/week @ 2025-03-10

2,494 downloads per month
Used in 15 crates (5 directly)

MPL-2.0 license

78KB
1.5K 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

~3.5–5MB
~102K SLoC