Struct ExternalPid 

pub struct ExternalPid {
    pub node: Atom,
    pub id: u32,
    pub serial: u32,
    pub creation: u32,
    pub local_ext_bytes: Option<Bytes>,
}

Represents an Erlang PID originating from a remote node. These are easy to get wrong when encoding and decoding due to the special LOCAL_EXT encoding.

When a PID is received via LOCAL_EXT, the original raw bytes are preserved in local_ext_bytes to allow for transparent re-encoding when sending the PID back to the remote node. LOCAL_EXT contains an opaque 8-byte hash that cannot be reconstructed from the parsed fields.

NEW_PID_EXT does NOT need raw bytes preserved because it can be exactly reconstructed from (node, id, serial, creation).

N.B.: the local_ext_bytes field is excluded from equality, hash, and ordering comparisons as it is nothing but an implementation detail. Two PIDs are equal if their (node, id, serial, creation) match, regardless of how they were encoded.

Fields

node: Atom

id: u32

serial: u32

creation: u32

local_ext_bytes: Option<Bytes>

If this PID was decoded from LOCAL_EXT, this contains the hash (8 bytes) and nested term bytes for transparent re-encoding.

Bytes offer zero-copy cloning.

Implementations

impl ExternalPid

pub fn new(node: Atom, id: u32, serial: u32, creation: u32) -> ExternalPid

pub fn with_local_ext_bytes( node: Atom, id: u32, serial: u32, creation: u32, local_ext_bytes: impl Into<Bytes>, ) -> ExternalPid

Creates a new PID with preserved LOCAL_EXT bytes.

Accepts any type that can be converted to Bytes (e.g., Vec<u8>, &[u8], Bytes).

pub fn is_local_ext(&self) -> bool

Returns true if this PID was decoded from LOCAL_EXT format.

pub fn from_string( node: Atom, pid_str: &str, ) -> Result<ExternalPid, DecodeError>

pub fn to_erl_pid_string(&self) -> String

pub fn from_erl_pid_string( node: Atom, pid_str: &str, creation: u32, ) -> Result<ExternalPid, DecodeError>

Parses a PID string in the format used by erlang:pid_to_list/1: <0.{id}.{serial}>. This is the format returned by to_erl_pid_string.

The node and creation must be passed in because they cannot be inferred from the input.

pub fn to_charlist_term(&self) -> OwnedTerm

Trait Implementations

impl Clone for ExternalPid

fn clone(&self) -> ExternalPid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalPid

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

Formats the value using the given formatter.

impl Display for ExternalPid

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

Formats the value using the given formatter.

impl Hash for ExternalPid

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 Ord for ExternalPid

fn cmp(&self, other: &ExternalPid) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ExternalPid

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ExternalPid

fn partial_cmp(&self, other: &ExternalPid) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ExternalPid