astrelis 0.2.4

A modular 2D/3D game engine framework
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

//! Async runtime plugin for background task execution.

use crate::plugin::Plugin;
use crate::resource::Resources;
use crate::task_pool::TaskPool;

/// Plugin that provides async task execution.
///
/// This plugin registers a `TaskPool` resource that can be used to spawn
/// async tasks for parallel execution. The task pool runs on background threads
/// and is suitable for:
///
/// - Async asset loading
/// - Network requests
/// - File I/O
/// - Computationally expensive operations
///
/// # Resources Provided
///
/// - `TaskPool` - Thread pool for executing async tasks
///
/// # Example
///
/// ```ignore
/// use astrelis::prelude::*;
///
/// let engine = Engine::builder()
///     .add_plugin(AsyncRuntimePlugin::default())
///     .build();
///
/// let pool = engine.get::<TaskPool>().unwrap();
/// let task = pool.spawn(async {
///     // Async work here
///     42
/// });
/// ```
#[derive(Default)]
pub struct AsyncRuntimePlugin {
    /// Number of threads for the task pool.
    /// If None, uses default (num_cpus - 1).
    pub num_threads: Option<usize>,
}

impl AsyncRuntimePlugin {
    /// Create a new async runtime plugin with default thread count.
    pub fn new() -> Self {
        Self::default()
    }

    /// Set the number of threads for the task pool.
    pub fn with_threads(mut self, num_threads: usize) -> Self {
        self.num_threads = Some(num_threads);
        self
    }
}

impl Plugin for AsyncRuntimePlugin {
    type Dependencies = ();

    fn name(&self) -> &'static str {
        "AsyncRuntimePlugin"
    }

    fn build(&self, resources: &mut Resources) {
        let pool = match self.num_threads {
            Some(n) => TaskPool::new(n),
            None => TaskPool::default_threads(),
        };

        tracing::debug!(
            "AsyncRuntimePlugin: Created TaskPool with {} threads",
            pool.thread_count()
        );

        resources.insert(pool);
    }

    fn cleanup(&self, resources: &mut Resources) {
        // Gracefully shutdown the task pool
        if let Some(pool) = resources.remove::<TaskPool>() {
            tracing::debug!("AsyncRuntimePlugin: Shutting down TaskPool");
            pool.shutdown();
        }
    }
}

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

    #[test]
    fn test_async_runtime_plugin_registers_task_pool() {
        let engine = EngineBuilder::new()
            .add_plugin(AsyncRuntimePlugin::default())
            .build();

        assert!(engine.get::<TaskPool>().is_some());
    }

    #[test]
    fn test_async_runtime_plugin_with_custom_threads() {
        let engine = EngineBuilder::new()
            .add_plugin(AsyncRuntimePlugin::new().with_threads(2))
            .build();

        let pool = engine.get::<TaskPool>().unwrap();
        assert_eq!(pool.thread_count(), 2);
    }

    #[test]
    fn test_task_pool_spawn() {
        let engine = EngineBuilder::new()
            .add_plugin(AsyncRuntimePlugin::default())
            .build();

        let pool = engine.get::<TaskPool>().unwrap();

        let task = pool.spawn(async { 42 });
        let result = pollster::block_on(task);

        assert_eq!(result, 42);
    }
}