Struct dirty2::Dirty

pub struct Dirty<T> { /* fields omitted */ }

Dirty wraps a value of type T with functions similiar to that of a Read/Write lock but simply sets a dirty flag on write(), reset on clear(). Use read() or deref (*dirty_variable) to access the inner value.

Implementations

impl<T> Dirty<T>

pub fn new(val: T) -> Dirty<T>

Create a new Dirty.

pub fn new_clean(val: T) -> Dirty<T>

Create a new Dirty with a clear dirty flag.

pub fn dirty(&self) -> bool

Returns true if dirty, false otherwise.

pub fn write(&mut self) -> &mut T

Writable value return, sets the dirty flag.

pub fn read(&self) -> &T

Read the value.

pub fn clear(&mut self)

Clears the dirty flag.

pub fn read_dirty(&self) -> Option<&T>

Read the value only if modified since last read.

pub fn unwrap(self) -> T

Consumes the wrapper and returns the enclosed value

Trait Implementations

impl<T: Clone> Clone for Dirty<T>

fn clone(&self) -> Dirty<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Copy> Copy for Dirty<T>

impl<T: Debug> Debug for Dirty<T>

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T: Default> Default for Dirty<T>

fn default() -> Dirty<T>

Returns the "default value" for a type.

impl<T> Deref for Dirty<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Eq> Eq for Dirty<T>

impl<T: Hash> Hash for Dirty<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<T: Ord> Ord for Dirty<T>

fn cmp(&self, other: &Dirty<T>) -> Ordering

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Dirty<T>> for Dirty<T>

fn eq(&self, other: &Dirty<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Dirty<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Dirty<T>> for Dirty<T>

fn partial_cmp(&self, other: &Dirty<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Dirty<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Dirty<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Dirty<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Dirty<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> StructuralEq for Dirty<T>

impl<T> StructuralPartialEq for Dirty<T>