beamr 0.4.2

A Rust runtime with the BEAM's execution model, targeting Gleam
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

//! Unified accessor for local and remote PID terms.

use crate::{
    atom::Atom,
    process::RemotePid,
    term::{Term, boxed::ExternalPid},
};

/// Borrowed PID accessor hiding immediate-local versus boxed-remote layout.
#[derive(Copy, Clone, Debug)]
pub enum PidRef {
    Local(u64),
    Remote(ExternalPid),
}

impl PidRef {
    /// Creates a PID accessor for local immediate or remote boxed PID terms.
    pub fn new(term: Term) -> Option<Self> {
        if let Some(pid) = term.as_pid() {
            return Some(Self::Local(pid));
        }
        ExternalPid::new(term).map(Self::Remote)
    }

    /// Returns the numeric process id component.
    #[must_use]
    pub fn pid_number(self) -> u64 {
        match self {
            Self::Local(pid) => pid,
            Self::Remote(pid) => pid.pid_number(),
        }
    }

    /// Returns the PID serial component; local immediate PIDs use serial 0.
    #[must_use]
    pub fn serial(self) -> u64 {
        match self {
            Self::Local(_) => 0,
            Self::Remote(pid) => pid.serial(),
        }
    }

    /// Returns the embedded remote node atom, or `None` for local PIDs.
    #[must_use]
    pub fn node(self) -> Option<Atom> {
        match self {
            Self::Local(_) => None,
            Self::Remote(pid) => pid.node(),
        }
    }

    /// Returns the stable remote identity, or `None` for local PIDs.
    #[must_use]
    pub fn remote_pid(self) -> Option<RemotePid> {
        let Self::Remote(pid) = self else {
            return None;
        };
        Some(RemotePid {
            node: pid.node()?,
            pid_number: pid.pid_number(),
            serial: pid.serial(),
        })
    }

    /// Returns true when the PID uses the local immediate representation.
    #[must_use]
    pub const fn is_local(self) -> bool {
        matches!(self, Self::Local(_))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::term::boxed::write_external_pid;

    #[test]
    fn pid_ref_wraps_local_immediate_pid() {
        let pid = PidRef::new(Term::pid(42)).expect("local pid");

        assert!(pid.is_local());
        assert_eq!(pid.pid_number(), 42);
        assert_eq!(pid.serial(), 0);
        assert_eq!(pid.node(), None);
    }

    #[test]
    fn pid_ref_wraps_remote_boxed_pid() {
        let mut heap = [0_u64; 4];
        let term = write_external_pid(&mut heap, Atom::OK, 99, 7).expect("external pid fits");
        let pid = PidRef::new(term).expect("remote pid");

        assert!(!pid.is_local());
        assert_eq!(pid.pid_number(), 99);
        assert_eq!(pid.serial(), 7);
        assert_eq!(pid.node(), Some(Atom::OK));
    }
}