Struct Jid 

pub struct Jid {
    pub user: CompactString,
    pub server: Server,
    pub agent: u8,
    pub device: u16,
    pub integrator: u16,
}

Fields

user: CompactString

server: Server

agent: u8

device: u16

integrator: u16

Implementations

impl Jid

pub fn new(user: impl Into<CompactString>, server: Server) -> Jid

pub fn pn(user: impl Into<CompactString>) -> Jid

Create a phone number JID (s.whatsapp.net)

pub fn lid(user: impl Into<CompactString>) -> Jid

Create a LID JID (lid server)

pub fn status_broadcast() -> Jid

Creates the status@broadcast JID used for status/story updates.

pub fn group(id: impl Into<CompactString>) -> Jid

Create a group JID (g.us).

pub fn newsletter(id: impl Into<CompactString>) -> Jid

Create a newsletter (channel) JID (newsletter server).

pub fn pn_device(user: impl Into<CompactString>, device: u16) -> Jid

Create a phone number JID with device ID

pub fn lid_device(user: impl Into<CompactString>, device: u16) -> Jid

Create a LID JID with device ID

pub fn is_pn(&self) -> bool

Returns true if this is a Phone Number based JID (s.whatsapp.net)

pub fn is_lid(&self) -> bool

Returns true if this is a LID based JID

pub fn user_base(&self) -> &str

Returns the user part without the device ID suffix (e.g., “123:4” -> “123”)

pub fn with_device(&self, device_id: u16) -> Jid

Helper to construct a specific device JID from this one

pub fn with_device_hosting(&self, device_id: u16, is_hosted: bool) -> Jid

Construct a device JID and select the hosted variant of PN/LID when indicated by a device-list entry.

Non-user namespaces are left unchanged because they have no hosted counterpart on the wire.

pub fn to_non_ad(&self) -> Jid

pub fn into_non_ad(self) -> Jid

Consuming to_non_ad: reuses the owned user instead of cloning it. Prefer this when the receiver is a throwaway owned Jid.

pub fn is_same_chat_as(&self, other: &Jid) -> bool

Device-insensitive “same chat” check: two JIDs address the same chat when they render to the same string ignoring the multi-device device. Compares user, server, integrator, and agent only where the server renders the agent (@bot/@interop); Pn/Lid/Hosted suppress it in display, so a stray decoded agent byte there must not split the chat. Allocates nothing. Stricter than is_same_user_as, which ignores server.

pub fn to_non_ad_string(&self) -> String

Canonical non-AD string form (user@server, device + agent stripped) in a single allocation. Equivalent to to_non_ad().to_string() but skips the throwaway intermediate Jid and its CompactString clone.

pub fn to_non_ad_arc_str(&self) -> Arc<str>

Self::to_non_ad_string as a shareable Arc<str>, in exactly one allocation. Going through the String first costs two — the buffer, then the Arc<str> its bytes are copied into — and the message-secret rows build two of these per message.

pub fn matches_user_or_lid(&self, user: &Jid, lid: Option<&Jid>) -> bool

Check if this JID matches the user or their LID. Useful for checking if a participant is “us” in group messages.

pub fn to_phash_form_string(&self) -> String

See Jid::push_phash_form_to. Not a general JID rendering — use Display/to_string for that.

pub fn push_phash_form_to(&self, buf: &mut String)

Append the form the participant hash is computed over (user.0:device@server) to buf, for callers that batch many JIDs into one shared buffer instead of paying a heap String per JID (see participant_list_hash).

This is not a general-purpose JID rendering. The agent position is the literal 0, never self.agent, and that is deliberate: WA Web’s formatFull spelling hardcodes ".0" unconditionally — there is no per-server carve-out, and WAWebWid has no agent field to read one from. The server recomputes this exact string to validate the phash, so writing our agent would mean a rejected hash for any JID that carried one.

If you want the JID as it is addressed, including the agent on the servers that render it, use Display / Jid::push_to instead.

pub fn push_to(&self, buf: &mut String)

Append the Display representation to buf using direct push operations, bypassing fmt::Display and dyn Write dispatch.

pub fn write_display_to<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Write + ?Sized,

Write the Display representation to any fmt::Write sink without an intermediate String.

pub fn display_eq(&self, other: &str) -> bool

Compare the display representation with other without allocating.

pub fn display_eq_jid(&self, other: &Jid) -> bool

Compare two JIDs by the representation emitted by fmt::Display.

pub fn device_eq(&self, other: &Jid) -> bool

Compare device identity (user, server, device) without allocation.

pub fn identity_agent(&self) -> u8

The agent as far as identity is concerned: the field itself where the server renders it (@bot, @interop), 0 where it does not.

Exposed so callers that build their own key over a JID — sorting, deduplicating, indexing — can key on the same rule == and Hash use instead of on the raw field, which would split one device in two or, in reverse, merge two real ones.

pub fn device_key(&self) -> DeviceKey<'_>

Get a borrowing key for O(1) HashSet lookups by device identity.

impl Jid

pub fn observe(&self) -> ObservedJid<'_>

Privacy-aware display for tracing spans/fields. See ObservedJid.

Trait Implementations

impl Clone for Jid

fn clone(&self) -> Jid

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Jid

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for Jid

fn default() -> Jid

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Jid

fn deserialize<__D>( __deserializer: __D, ) -> Result<Jid, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Jid

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl DsmDestination for Jid

fn encoded_len(&self) -> usize

Exactly the number of bytes Self::write_into appends.

fn write_into(&self, out: &mut Vec<u8>)

Appends the destination’s wire form, whose length must equal Self::encoded_len.

impl Eq for Jid

impl From<&Jid> for Jid

Lets impl Into<Jid> APIs accept &Jid transparently: borrow-callers pay one cheap clone (the user part is inline for typical numeric ids), owned callers move for free.

fn from(jid: &Jid) -> Jid

Converts to this type from the input type.

impl FromStr for Jid

type Err = JidError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Jid, <Jid as FromStr>::Err>

Parses a string s to return a value of this type.

impl Hash for Jid

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl HeapSize for Jid

fn heap_bytes(&self) -> usize

impl JidExt for Jid

fn to_signal_address_string(&self) -> String

fn to_protocol_address(&self) -> ProtocolAddress

fn to_protocol_address_string(&self) -> String

fn reset_protocol_address(&self, addr: &mut ProtocolAddress)

Rewrite a reusable ProtocolAddress in place for this JID. Writes directly into the address — no intermediate buffer needed.

impl JidExt for Jid

fn user(&self) -> &str

fn server(&self) -> Server

fn device(&self) -> u16

fn integrator(&self) -> u16

fn is_ad(&self) -> bool

fn is_interop(&self) -> bool

fn is_messenger(&self) -> bool

fn is_group(&self) -> bool

fn is_broadcast_list(&self) -> bool

fn is_status_broadcast(&self) -> bool

fn is_psa(&self) -> bool

The system/announcements account (0@s.whatsapp.net / 0@c.us). It never answers user-directed IQs, so requests must be short-circuited client-side (WA Web excludes it via isPSA before hitting the server).

fn is_bot(&self) -> bool

fn is_newsletter(&self) -> bool

fn is_hosted(&self) -> bool

Returns true if this is a hosted/Cloud API device. Hosted devices have device ID 99 or use @hosted/@hosted.lid server. These devices should be excluded from group message fanout.

fn is_empty(&self) -> bool

fn is_same_user_as(&self, other: &impl JidExt) -> bool

impl PartialEq for Jid

fn eq(&self, other: &Jid) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PartialEq<JidRef<'_>> for Jid

fn eq(&self, other: &JidRef<'_>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Jid

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<String> for Jid

type Error = JidError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Jid, <Jid as TryFrom<String>>::Error>

Performs the conversion.