irc-bot 0.2.1

A library for writing Internet Relay Chat (IRC) bots in Rust
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

use core::ErrorKind;
use core::Result;
use std::borrow::Cow;
use std::sync::Mutex;
use std::sync::MutexGuard;
use std::sync::PoisonError;
use std::sync::RwLock;
use std::sync::RwLockReadGuard;
use std::sync::RwLockWriteGuard;

pub(crate) trait RwLockExt<T> {
    /// Acquires the lock for reading if it is clean (i.e., not poisoned).
    ///
    /// If the lock is poisoned, returns an error saying that a lock of the given `description` was
    /// poisoned.
    fn read_clean<Desc>(&self, description: Desc) -> Result<RwLockReadGuard<T>>
    where
        Desc: Into<Cow<'static, str>>;

    /// Acquires the lock for writing if it is clean (i.e., not poisoned).
    ///
    /// If the lock is poisoned, returns an error saying that a lock of the given `description` was
    /// poisoned.
    fn write_clean<Desc>(&self, description: Desc) -> Result<RwLockWriteGuard<T>>
    where
        Desc: Into<Cow<'static, str>>;
}

impl<T> RwLockExt<T> for RwLock<T> {
    fn read_clean<Desc>(&self, description: Desc) -> Result<RwLockReadGuard<T>>
    where
        Desc: Into<Cow<'static, str>>,
    {
        self.read()
            .map_err(|PoisonError { .. }| ErrorKind::LockPoisoned(description.into().into()).into())
    }

    fn write_clean<Desc>(&self, description: Desc) -> Result<RwLockWriteGuard<T>>
    where
        Desc: Into<Cow<'static, str>>,
    {
        self.write()
            .map_err(|PoisonError { .. }| ErrorKind::LockPoisoned(description.into().into()).into())
    }
}

pub(crate) trait MutexExt<T> {
    /// Acquires the lock if it is clean (i.e., not poisoned).
    ///
    /// If the lock is poisoned, returns an error saying that a lock of the given `description` was
    /// poisoned.
    fn lock_clean<Desc>(&self, description: Desc) -> Result<MutexGuard<T>>
    where
        Desc: Into<Cow<'static, str>>;
}

impl<T> MutexExt<T> for Mutex<T> {
    fn lock_clean<Desc>(&self, description: Desc) -> Result<MutexGuard<T>>
    where
        Desc: Into<Cow<'static, str>>,
    {
        self.lock()
            .map_err(|PoisonError { .. }| ErrorKind::LockPoisoned(description.into().into()).into())
    }
}