rumdl 0.3.0

A fast Markdown linter and formatter written 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

//! Invocation-scoped accounting, shared by files and tool phases.

use std::collections::BTreeMap;
use std::sync::Mutex;
use std::sync::atomic::{AtomicBool, AtomicUsize, Ordering};

#[derive(Debug, Default)]
pub struct RunState {
    executions: AtomicUsize,
    aborted: AtomicBool,
    cached_checks: AtomicUsize,
    warnings: Mutex<BTreeMap<String, String>>,
}

// Operational state is excluded from configuration serialization and identity.
impl PartialEq for RunState {
    fn eq(&self, _other: &Self) -> bool {
        true
    }
}
impl Eq for RunState {}

impl RunState {
    pub fn abort(&self) {
        self.aborted.store(true, Ordering::Relaxed);
    }
    pub fn aborted(&self) -> bool {
        self.aborted.load(Ordering::Relaxed)
    }
    pub fn record_execution(&self) {
        self.executions.fetch_add(1, Ordering::Relaxed);
    }
    pub fn record_cached_check(&self) {
        self.cached_checks.fetch_add(1, Ordering::Relaxed);
    }
    pub fn checked_anything(&self) -> bool {
        self.executions.load(Ordering::Relaxed) > 0 || self.cached_checks.load(Ordering::Relaxed) > 0
    }
    pub fn warn(&self, key: String, message: String) {
        self.warnings
            .lock()
            .unwrap_or_else(std::sync::PoisonError::into_inner)
            .entry(key)
            .or_insert(message);
    }
    pub fn warnings(&self) -> Vec<String> {
        self.warnings
            .lock()
            .unwrap_or_else(std::sync::PoisonError::into_inner)
            .values()
            .cloned()
            .collect()
    }
}