Struct track::Tracker

pub struct Tracker<'borrow, 'notifier, C, S, I> where
    C: TrackableMarker,
    S: SerializationStrategy,
    I: Identifier,  { /* fields omitted */ }

Tracks value modifications of a type and sends events with these changes.

The Tracker implements DerefMut which makes it possible to treat this tracker as if you are working with the type you track. On Drop it checks if modifications have been made. If this is the case only the modified fields in an event will be sent to the given sender.

Methods

impl<'borrow, 'notifier, C, S, I> Tracker<'borrow, 'notifier, C, S, I> where
    C: TrackableMarker,
    S: SerializationStrategy,
    I: Identifier, 

pub fn new(
    borrow: &'borrow mut C,
    notifier: &'notifier Sender<ModificationEvent<I>>,
    serialization: S,
    identifier: I
) -> Tracker<'borrow, 'notifier, C, S, I>

Constructs a new tracker.

• borrow: mutable reference to the object which modifications are tracked.
• notifier: a sender where mutation events are sent.
• serialization: an instance of a type that implements SerializationStrategy strategy. This serializer is needed to monitor the changes and the serialized mutations are sent along with the event.
• identifier: An identifier with which you can relate the modification event to your type. The identifier should implement Identifier

Trait Implementations

impl<'borrow, 'notifier, C, S, I> Deref for Tracker<'borrow, 'notifier, C, S, I> where
    C: TrackableMarker,
    S: SerializationStrategy,
    I: Identifier, 

type Target = C

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Returns a reference to the underlying type being tracked.

impl<'borrow, 'notifier, C, S, I> DerefMut for Tracker<'borrow, 'notifier, C, S, I> where
    C: TrackableMarker,
    S: SerializationStrategy,
    I: Identifier, 

fn deref_mut(&mut self) -> &mut Self::Target

Returns a mutable reference to the underlying type being tracked.

impl<'borrow, 'notifier, C, S, I> Drop for Tracker<'borrow, 'notifier, C, S, I> where
    C: TrackableMarker,
    S: SerializationStrategy,
    I: Identifier, 

fn drop(&mut self)

Checks to see if any field values have changed. If this is the case, the changed fields will be packed into an event and an event will be sent.