ckb-util 0.38.0

TODO(doc): @doitian crate description
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

//! CKB utilities.
//!
//! Collection of frequently used utilities.
mod linked_hash_set;
mod shrink_to_fit;
pub mod strings;

use std::time::Duration;

pub use linked_hash_map::{Entries as LinkedHashMapEntries, LinkedHashMap};
pub use linked_hash_set::LinkedHashSet;

pub use parking_lot::{
    self, Condvar, Mutex, MutexGuard, RwLock, RwLockReadGuard, RwLockWriteGuard,
};

/// The timeout that [`lock_or_panic`] waits before it panics.
///
/// It is set to 300 seconds.
///
/// [`lock_or_panic`]: fn.lock_or_panic.html
pub const TRY_LOCK_TIMEOUT: Duration = Duration::from_secs(300);

/// Holds the mutex lock or panics after timeout.
///
/// This is used to panic and restart the app on potential dead lock.
///
/// Try to hold the lock or panic after the timeout [`TRY_LOCK_TIMEOUT`].
///
/// [`TRY_LOCK_TIMEOUT`]: constant.TRY_LOCK_TIMEOUT.html
pub fn lock_or_panic<T>(data: &Mutex<T>) -> MutexGuard<T> {
    data.try_lock_for(TRY_LOCK_TIMEOUT)
        .expect("please check if reach a deadlock")
}