dirtytype 0.6.0

A marker of types being dirty for 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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

#![doc = include_str!("../README.md")]
use std::ops::{Deref, DerefMut};

/// A struct that stores a `T` and marks if the data inside has been modified.
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord)]
pub struct Dirty<T> {
    /// The data stored in the type. Typically accessed by dereferencing, but can be modified here to avoid being marked as dirty.
    pub data: T,
    /// Whether the data is dirty or not.
    pub dirty: bool,
}

impl<T> Dirty<T> {
    /// Create a new `Clean` value of `t`.
    pub fn new(data: T) -> Self {
        Self { data, dirty: false }
    }

    /// Calls the closure if the data is dirty, and then marks the data as clean.
    pub fn clean(&mut self, mut f: impl FnMut(&mut T)) {
        if self.dirty {
            self.dirty = false;
            f(&mut self.data);
        }
    }

    /// Returns a reference to the held value if it is dirty and `None` otherwise.
    pub fn as_dirty(&self) -> Option<&T> {
        if self.dirty {
            Some(&self.data)
        } else {
            None
        }
    }

    /// Returns a reference to the held value if it is clean and `None` otherwise.
    pub fn as_clean(&self) -> Option<&T> {
        if self.dirty {
            None
        } else {
            Some(&self.data)
        }
    }

    /// Returns a mutable reference to the held value if it is dirty and `None` otherwise.
    pub fn as_dirty_mut(&mut self) -> Option<&mut T> {
        if self.dirty {
            Some(&mut self.data)
        } else {
            None
        }
    }

    /// Returns a mutable reference to the held value if it is clean and `None` otherwise.
    pub fn as_clean_mut(&mut self) -> Option<&mut T> {
        if self.dirty {
            None
        } else {
            Some(&mut self.data)
        }
    }
}

impl<T> AsRef<T> for Dirty<T> {
    fn as_ref(&self) -> &T {
        self.deref()
    }
}

impl<T> AsMut<T> for Dirty<T> {
    fn as_mut(&mut self) -> &mut T {
        self.deref_mut()
    }
}

impl<T: Default> Default for Dirty<T> {
    fn default() -> Self {
        Self::new(T::default())
    }
}

impl<T> Deref for Dirty<T> {
    type Target = T;
    fn deref(&self) -> &Self::Target {
        &self.data
    }
}

impl<T> DerefMut for Dirty<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        self.dirty = true;
        &mut self.data
    }
}

impl<T> From<T> for Dirty<T> {
    fn from(value: T) -> Self {
        Self::new(value)
    }
}