Skip to main content

SimLogger

Struct SimLogger 

Source
pub struct SimLogger {
    pub entries: Vec<SimLogEntry>,
    pub flush_interval: usize,
    /* private fields */
}
Expand description

Append-only simulation logger with CSV and JSON serialisation.

Fields§

§entries: Vec<SimLogEntry>

All logged entries in chronological order.

§flush_interval: usize

How many entries to buffer before auto-flushing (0 = manual only).

Implementations§

Source§

impl SimLogger

Source

pub fn new() -> Self

Create a new logger.

Source

pub fn with_flush_interval(flush_interval: usize) -> Self

Create a logger with an auto-flush interval.

Source

pub fn append(&mut self, entry: SimLogEntry)

Append a new entry.

Source

pub fn len(&self) -> usize

Return the number of logged entries.

Source

pub fn is_empty(&self) -> bool

Returns true if no entries have been logged.

Source

pub fn all_custom_keys(&self) -> Vec<String>

Collect all unique custom field keys across all entries (sorted).

Source

pub fn to_csv(&self) -> String

Serialise all entries to a CSV string.

The first line is a header row. Custom field columns appear in sorted key order.

Source

pub fn to_json(&self) -> String

Serialise all entries to a JSON array string.

Source

pub fn flush(&mut self) -> Vec<String>

Flush buffered lines and return them (clears the buffer).

Trait Implementations§

Source§

impl Clone for SimLogger

Source§

fn clone(&self) -> SimLogger

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SimLogger

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SimLogger

Source§

fn default() -> SimLogger

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.