Skip to main content

qubit_function/tasks/runnable_with/
arc_runnable_with.rs

1/*******************************************************************************
2 *
3 *    Copyright (c) 2025 - 2026.
4 *    Haixing Hu, Qubit Co. Ltd.
5 *
6 *    All rights reserved.
7 *
8 ******************************************************************************/
9//! Defines the `ArcRunnableWith` public type.
10
11#![allow(unused_imports)]
12
13use super::*;
14
15/// Thread-safe shared runnable with mutable input.
16///
17/// `ArcRunnableWith<T, E>` stores an
18/// `Arc<Mutex<dyn FnMut(&mut T) -> Result<(), E> + Send>>`.
19///
20/// # Author
21///
22/// Haixing Hu
23pub struct ArcRunnableWith<T, E> {
24    /// The stateful closure executed by this runnable.
25    pub(super) function: Arc<Mutex<dyn FnMut(&mut T) -> Result<(), E> + Send>>,
26    /// The optional name of this runnable.
27    pub(super) name: Option<String>,
28}
29
30impl<T, E> Clone for ArcRunnableWith<T, E> {
31    #[inline]
32    fn clone(&self) -> Self {
33        Self {
34            function: Arc::clone(&self.function),
35            name: self.name.clone(),
36        }
37    }
38}
39
40impl<T, E> ArcRunnableWith<T, E> {
41    impl_common_new_methods!(
42        (FnMut(&mut T) -> Result<(), E> + Send + 'static),
43        |function| Arc::new(Mutex::new(function)),
44        "runnable-with"
45    );
46
47    impl_common_name_methods!("runnable-with");
48}
49
50impl<T, E> RunnableWith<T, E> for ArcRunnableWith<T, E> {
51    /// Executes the thread-safe runnable with mutable input.
52    #[inline]
53    fn run_with(&mut self, input: &mut T) -> Result<(), E> {
54        (self.function.lock())(input)
55    }
56
57    impl_arc_conversions!(
58        ArcRunnableWith<T, E>,
59        BoxRunnableWith,
60        RcRunnableWith,
61        FnMut(input: &mut T) -> Result<(), E>
62    );
63}
64
65impl_closure_trait!(
66    RunnableWith<T, E>,
67    run_with,
68    FnMut(input: &mut T) -> Result<(), E>
69);
70
71impl_function_debug_display!(BoxRunnableWith<T, E>);
72impl_function_debug_display!(RcRunnableWith<T, E>);
73impl_function_debug_display!(ArcRunnableWith<T, E>);