Struct CapnProtoTracker 

pub struct CapnProtoTracker { /* private fields */ }

A tracker that writes Cap’n Proto binary data

Implementations

impl CapnProtoTracker

pub fn new(entity_manager: EntityManager, writer: Writer) -> Self

Create a new CapnProtoTracker with an EntityManager

Trait Implementations

impl Track for CapnProtoTracker

Implementation each Track event

There is a function to emit each Cap’n Proto event structure. These functions call the helper function write_event, passing in a function that is used to populate the event body.

fn unique_id(&self) -> Id

Allocate a new global ID

fn enabled_level(&self, id: Id) -> Level

Determine the most verbose tracking level enabled for an entity.

fn monitoring_window_size_for(&self, id: Id) -> Option<u64>

Return the monitoring window size if it is to be enabled. Entity looked up by its ID.

fn add_entity( &self, id: Id, entity_name: &str, alternative_names: AlternativeNames<'_>, ) -> Level

Record an entity being created.

fn enter(&self, id: Id, object: Id)

Track when an entity with the given ID arrives.

fn exit(&self, id: Id, object: Id)

Track when an entity with the given ID leaves.

fn value(&self, id: Id, value: f64)

Track an entity setting a value.

fn begin_activity(&self, activity: Id, lane: Id, name: &str)

Track the beginning of a named activity on a lane.

fn add_to_group(&self, activity: Id, group_id: Id)

Track when an activity becomes a member of a group.

fn remove_from_group(&self, activity: Id, group_id: Id)

Track when an activity is no longer a member of a group.

fn end_activity(&self, activity: Id)

Track the end of the current activity on a lane.

fn create_entity(&self, created_by: Id, id: Id, name: &str)

Track when an entity with the given ID is created.

fn create_monitor(&self, created_by: Id, id: Id, name: &str)

Track when a monitor with the given ID is created.

fn create_lane(&self, created_by: Id, id: Id, name: &str)

Track when a lane with the given ID is created.

fn create_group(&self, created_by: Id, id: Id, name: &str)

Track when a group with the given ID is created.

fn create_object( &self, created_by: Id, id: Id, size: usize, units: &str, req_type: u8, details: &str, )

Track when an object with the given ID is created.

fn capacity(&self, id: Id, capacity: Capacity)

Track the capacity available in an entity.

fn destroy(&self, destroyed_by: Id, id: Id)

Track when an entity with the given ID is destroyed.

fn connect(&self, connect_from: Id, connect_to: Id)

Track when an entity is connected to another entity

fn log(&self, id: Id, level: Level, msg: Arguments<'_>)

Track a log message of the given level.

fn time(&self, set_by: Id, time_ns: f64)

Advance the time to the time specified in ns.

fn shutdown(&self)

Perform any pre-exit shutdown/cleanup

fn is_entity_enabled(&self, id: Id, level: Level) -> bool

Determine whether tracking is enabled at a given level for an entity.