shared-type 1.0.0

Shared type alias and several traits to simplify working with Arc<Mutex<T>>.
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

// *************************************************************************
//
// Copyright (c) 2025 Andrei Gramakov. All rights reserved.
//
// This file is licensed under the terms of the MIT license.
// For a copy, see: https://opensource.org/licenses/MIT
//
// site:    https://agramakov.me
// e-mail:  mail@agramakov.me
//
// *************************************************************************
use std::sync::{Arc, Mutex};

#[cfg(test)]
mod tests;

pub type Shared<T> = Arc<Mutex<T>>;

/// Convenience trait to add `into_shared()` to any type
pub trait IntoShared<T> {
    fn into_shared(self) -> Shared<T>;
}

impl<T> IntoShared<T> for T {
    fn into_shared(self) -> Shared<T> {
        Arc::new(Mutex::new(self))
    }
}

pub trait WithSharedInner<T> {
    /// Waits for the lock to become available and then calls the closure
    fn with_inner<F, R>(&self, func: F) -> Option<R>
    where
        F: FnOnce(&mut T) -> R;

    /// Immediately locks the mutex and calls the closure
    fn try_with_inner<F, R>(&self, func: F) -> Option<R>
    where
        F: FnOnce(&mut T) -> R;
}

impl<T> WithSharedInner<T> for Shared<T> {
    fn with_inner<F, R>(&self, func: F) -> Option<R>
    where
        F: FnOnce(&mut T) -> R,
    {
        self.lock().ok().map(|mut guard| func(&mut *guard))
    }

    fn try_with_inner<F, R>(&self, func: F) -> Option<R>
    where
        F: FnOnce(&mut T) -> R,
    {
        self.try_lock().ok().map(|mut guard| func(&mut *guard))
    }
}