#xmpp #struct #id #part #node #resources #jabber-id

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

#4 in #xmpp

Download history 23/week @ 2024-01-22 15/week @ 2024-01-29 68/week @ 2024-02-05 44/week @ 2024-02-12 165/week @ 2024-02-19 97/week @ 2024-02-26 76/week @ 2024-03-04 102/week @ 2024-03-11 62/week @ 2024-03-18 113/week @ 2024-03-25 175/week @ 2024-04-01 150/week @ 2024-04-08 89/week @ 2024-04-15 73/week @ 2024-04-22 66/week @ 2024-04-29 66/week @ 2024-05-06

309 downloads per month
Used in 13 crates (4 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
~134K SLoC