Struct History

pub struct History<Event>(/* private fields */);

The tracking history of a target.

A history is a sequence of the tracked events.

Examples

use std::fmt::{Display, Formatter, Result};
use trackable::History;

struct Event(&'static str);
impl Display for Event {
    fn fmt(&self, f: &mut Formatter) -> Result {
        write!(f, "event: {}", self.0)
    }
}

let mut history = History::new();
history.add(Event("foo"));
history.add(Event("bar"));

assert_eq!(format!("\n{}", history), r#"
HISTORY:
  [0] event: foo
  [1] event: bar
"#);

Implementations

impl<Event> History<Event>

pub fn new() -> Self

Makes an empty history.

pub fn add(&mut self, event: Event)

Adds an event to the tail of this history.

pub fn events(&self) -> &[Event]

Returns the tracked events in this history.

Trait Implementations

impl<Event: Clone> Clone for History<Event>

fn clone(&self) -> History<Event>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Event: Debug> Debug for History<Event>

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

Formats the value using the given formatter.

impl<Event> Default for History<Event>

fn default() -> Self

Returns the “default value” for a type.

impl<'de, Event> Deserialize<'de> for History<Event>

where Event: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Event: Display> Display for History<Event>

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

Formats the value using the given formatter.

impl<Event> Serialize for History<Event>

where Event: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.