logisheets_controller 0.7.0

the core of LogiSheets
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

//! Since this library should be used in these two circumstances:
//! - standalone version. This is used in the browser or as a rust library which is single threaded.
//! - sequencer version. This is used in the sequencer to support the co-working
//!
//! We don't want any compromise on the performance in the standalone version and we redefined a locked type,
//! which is designed to use `RefCell` or `RwLock` depends on the feature.
//!
//! Ref: https://github.com/rhaiscript/rhai/blob/main/src/func/native.rs#L554

#[cfg(not(feature = "sequencer"))]
pub use std::cell::RefCell as Locked;

#[cfg(not(feature = "sequencer"))]
pub type LockGuard<'a, T> = std::cell::Ref<'a, T>;

#[cfg(not(feature = "sequencer"))]
pub type LockGuardMut<'a, T> = std::cell::RefMut<'a, T>;

#[cfg(feature = "sequencer")]
// pub use std::sync::RwLock as Locked;
pub type Locked<T> = std::sync::Arc<std::sync::RwLock<T>>;

#[cfg(feature = "sequencer")]
#[allow(dead_code)]
pub type LockGuard<'a, T> = std::sync::RwLockReadGuard<'a, T>;

#[cfg(feature = "sequencer")]
#[allow(dead_code)]
pub type LockGuardMut<'a, T> = std::sync::RwLockWriteGuard<'a, T>;

#[inline(always)]
#[must_use]
#[allow(dead_code)]
pub fn locked_read<T>(value: &Locked<T>) -> LockGuard<T> {
    #[cfg(not(feature = "sequencer"))]
    return value.borrow();

    #[cfg(feature = "sequencer")]
    return value.read().unwrap();
}

#[inline(always)]
#[must_use]
#[allow(dead_code)]
pub fn locked_write<T>(value: &Locked<T>) -> LockGuardMut<T> {
    #[cfg(not(feature = "sequencer"))]
    return value.borrow_mut();

    #[cfg(feature = "sequencer")]
    return value.write().unwrap();
}

pub fn new_locked<T>(value: T) -> Locked<T> {
    #[cfg(not(feature = "sequencer"))]
    return std::cell::RefCell::new(value);

    #[cfg(feature = "sequencer")]
    return Locked::new(std::sync::RwLock::new(value));
}