goish 0.20.7

Goish Rust — write Rust using Go idioms. Ports Go's standard library and syntax so Go programmers can write Rust code that reads and feels like Go.
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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

// runtime: Go's runtime package — a minimal subset of introspection helpers.
//
//   Go                                  goish
//   ─────────────────────────────────   ──────────────────────────────────
//   runtime.NumCPU()                    runtime::NumCPU()
//   runtime.GOMAXPROCS(0)               runtime::GOMAXPROCS(0)
//   runtime.Gosched()                   runtime::Gosched()
//   runtime.GOOS                        runtime::GOOS
//   runtime.GOARCH                      runtime::GOARCH
//   runtime.NumGoroutine()              runtime::NumGoroutine()   // best-effort
//   runtime.Version()                   runtime::Version()
//
// Caveat: NumGoroutine counts live goroutines started through `go!`
// (best-effort). Each goroutine is a tokio async task (~200 B); runtime
// scales to 1M per process (tests/million_goroutines.rs).

use crate::types::int;
use std::sync::atomic::{AtomicUsize, Ordering};

pub const GOOS: &str = std::env::consts::OS;
pub const GOARCH: &str = std::env::consts::ARCH;

static GOMAXPROCS_SETTING: AtomicUsize = AtomicUsize::new(0);
pub(crate) static LIVE_GOROUTINES: AtomicUsize = AtomicUsize::new(1); // main counts as 1

#[allow(non_snake_case)]
pub fn NumCPU() -> int {
    std::thread::available_parallelism()
        .map(|n| n.get() as int)
        .unwrap_or(1)
}

/// GOMAXPROCS(n) — if n > 0, sets the stored value and returns the previous;
/// if n == 0, returns the current setting (defaulting to NumCPU() if unset).
#[allow(non_snake_case)]
pub fn GOMAXPROCS(n: int) -> int {
    let prev = GOMAXPROCS_SETTING.load(Ordering::SeqCst);
    let effective = if prev == 0 { NumCPU() as usize } else { prev };
    if n > 0 {
        GOMAXPROCS_SETTING.store(n as usize, Ordering::SeqCst);
    }
    effective as int
}

/// Gosched — yield the current thread.
#[allow(non_snake_case)]
pub fn Gosched() {
    std::thread::yield_now();
}

/// NumGoroutine — best-effort live goroutine count (including main).
#[allow(non_snake_case)]
pub fn NumGoroutine() -> int {
    LIVE_GOROUTINES.load(Ordering::SeqCst) as int
}

#[allow(non_snake_case)]
pub fn Version() -> &'static str {
    // Not semantically the Go toolchain version; report goish crate + note.
    concat!("goish-", env!("CARGO_PKG_VERSION"))
}

// ── Goexit ─────────────────────────────────────────────────────────────
//
// Go's `runtime.Goexit()` terminates the calling goroutine after running
// any deferred calls. We model it as a panic-with-sentinel:
//   - scope-guard `defer!{}`s still fire (they run on drop during unwind)
//   - the `test!` harness and `go!{}` wrapper both recognise the sentinel
//     and treat it as a clean exit (not a panic)
//
// Calling Goexit from the *main* goroutine in a non-test binary will
// terminate the process via the unwinding panic — same shape as Go.

#[doc(hidden)]
#[derive(Debug)]
pub struct GoexitSentinel;

/// Returns true if the given panic payload is a Goexit.
#[doc(hidden)]
pub fn is_goexit_panic(e: &Box<dyn std::any::Any + Send>) -> bool {
    e.is::<GoexitSentinel>()
}

/// runtime.Goexit — terminate the current goroutine, running deferred
/// functions. See the comment above for semantics inside the test harness.
#[allow(non_snake_case)]
pub fn Goexit() -> ! {
    std::panic::panic_any(GoexitSentinel);
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn num_cpu_positive() {
        assert!(NumCPU() >= 1);
    }

    #[test]
    fn gomaxprocs_roundtrip() {
        let prev = GOMAXPROCS(0);
        assert!(prev >= 1);
        let prev2 = GOMAXPROCS(4);
        assert_eq!(prev2, prev);
        assert_eq!(GOMAXPROCS(0), 4);
        // restore
        GOMAXPROCS(prev);
    }

    #[test]
    fn gosched_runs() {
        Gosched();
    }

    #[test]
    fn os_and_arch_nonempty() {
        assert!(!GOOS.is_empty());
        assert!(!GOARCH.is_empty());
    }

    #[test]
    fn version_format() {
        assert!(Version().starts_with("goish-"));
    }
}