merfolk 0.1.4

A minimal extensible RPC framework. Cross platform and `no_std`
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

//! The [`SmartLock`] type can be created and accessed with macros.
//! Its internal structure depends on the `std` feature.
//!
//! The type is an alias for [`alloc::sync::Arc`]`<`[`std::sync::Mutex`]`<T>>` in `std` contexts and [`alloc::sync::Arc`]`<`[`spin::Mutex`]`<T>>` in `no_std` contexts.
//!
//! # Example
//! ```
//! # extern crate alloc;
//! # use merfolk::{smart_lock, access, clone_lock, helpers::smart_lock::SmartLock};
//!
//! let lock: SmartLock<String> = smart_lock!("Hello".to_string());
//!
//! *access!(lock).unwrap() += ", World!";
//!
//! let lock_clone = clone_lock!(lock);
//! println!("{}", access!(lock).unwrap()); // Hello, World!
//! ```

#[cfg(feature = "std")]
//#[doc(cfg(feature = "std"))]
#[macro_export]
/// Expands to the Type [`alloc::sync::Arc`]`<`[`std::sync::Mutex`]`<T>>`.
macro_rules! smart_lock_type {
  ($x:ty) => {
    alloc::sync::Arc<std::sync::Mutex<$x>>
  }
}

#[cfg(not(feature = "std"))]
//#[doc(cfg(not(feature = "std")))]
#[macro_export]
/// Expands to the Type [`alloc::sync::Arc`]`<`[`spin::Mutex`]`<T>>`.
macro_rules! smart_lock_type {
  ($x:ty) => {
    alloc::sync::Arc<spin::Mutex<$x>>
  }
}

/// Type alias for the macro [`smart_lock_type`].
pub type SmartLock<T> = smart_lock_type!(T);

#[cfg(feature = "std")]
#[macro_export]
/// Create a [`SmartLock`].
macro_rules! smart_lock {
  ($x:expr) => {
    alloc::sync::Arc::new(std::sync::Mutex::new($x))
  };
}

#[cfg(not(feature = "std"))]
#[macro_export]
/// Create a [`SmartLock`].
macro_rules! smart_lock {
  ($x:expr) => {
    alloc::sync::Arc::new(spin::Mutex::new($x))
  };
}

#[macro_export]
/// Clone a [`SmartLock`].
macro_rules! clone_lock {
  ($x:expr) => {
    $x.clone()
  };
}

#[cfg(feature = "std")]
#[macro_export]
/// Access a [`SmartLock`].
macro_rules! access {
  ($x:expr) => {
    $x.lock()
  };
}

#[cfg(not(feature = "std"))]
#[macro_export]
/// Access a [`SmartLock`].
macro_rules! access {
  ($x:expr) => {
    Ok::<spin::mutex::MutexGuard<_>, core::convert::Infallible>($x.lock())
  };
}