vthread_stack/
suspension.rs1use std::{error::Error, fmt, time::Instant};
4
5#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
7pub struct ParkToken {
8 wait: u64,
9 generation: u64,
10}
11
12impl ParkToken {
13 pub fn new(wait: u64, generation: u64) -> Self {
15 Self { wait, generation }
16 }
17
18 pub fn wait(self) -> u64 {
20 self.wait
21 }
22
23 pub fn generation(self) -> u64 {
25 self.generation
26 }
27}
28
29#[derive(Clone, Debug, PartialEq, Eq)]
31pub struct ParkRequest {
32 token: ParkToken,
33 deadline: Option<Instant>,
34}
35
36impl ParkRequest {
37 pub fn new(token: ParkToken, deadline: Option<Instant>) -> Self {
39 Self { token, deadline }
40 }
41
42 pub fn token(&self) -> ParkToken {
44 self.token
45 }
46
47 pub fn deadline(&self) -> Option<Instant> {
49 self.deadline
50 }
51}
52
53#[derive(Clone, Debug, PartialEq, Eq)]
55pub enum Suspension {
56 YieldNow,
58 Park(ParkRequest),
60}
61
62#[derive(Clone, Debug, PartialEq, Eq)]
64pub enum FiberState {
65 Suspended(Suspension),
67 Complete,
69}
70
71#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
73pub enum Resume {
74 #[default]
76 Continue,
77 Interrupt,
79}
80
81#[derive(Clone, Copy, Debug, PartialEq, Eq)]
83pub enum SuspendError {
84 NotMounted,
86 Panicking,
88}
89
90impl fmt::Display for SuspendError {
91 fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
92 match self {
93 Self::NotMounted => {
94 formatter.write_str("no virtual-thread stack is mounted on this carrier")
95 }
96 Self::Panicking => formatter.write_str(
97 "a virtual-thread stack cannot suspend while its carrier is handling a panic",
98 ),
99 }
100 }
101}
102
103impl Error for SuspendError {}
104
105#[cfg(test)]
106#[path = "suspension_test.rs"]
107mod suspension_test;