ocean.util.log.PeriodicTrace

Two global instances of this struct exist for convenience: PeriodicTrace and StaticPeriodicTrace. The latter has the static_display flag set to true.

Usage example with the global instance:

import ocean.util.log.PeriodicTrace;

const ulong trace_interval = 500_000; // only update display after at least half a second has passed

for ( uint i; i < uint.max; i++ )
{
    StaticPeriodicTrace.format(trace_interval, "{}", i);
}

A local instance of the PeriodicTracer struct may be useful in situations where two or more separate periodic outputs are required each with a different update interval.

Usage example with a local instance:

import ocean.util.log.PeriodicTrace;

PeriodicTracer trace1;
trace1.interval = 500_000; // only update display after at least half a second has passed

PeriodicTracer trace2;
trace2.interval = 5_000_000; // only update display after at least 5 seconds have passed

for ( uint i; i < uint.max; i++ )
{
    trace1.format("{}", i);
    trace2.format("{}", i);
}

Note: this struct automatically calls Trace.flush / StaticTrace.flush after updating.