Struct abstutil::time::Timer

pub struct Timer<'a> {
    results: Vec<String>,
    stack: Vec<StackEntry>,
    outermost_name: String,
    notes: Vec<String>,
    pub(crate) warnings: Vec<String>,
    pub(crate) errors: Vec<String>,
    sink: Option<Box<dyn TimerSink + 'a>>,
}

Hierarchial magic

Fields

results: Vec<String>

stack: Vec<StackEntry>

outermost_name: String

notes: Vec<String>

warnings: Vec<String>

errors: Vec<String>

sink: Option<Box<dyn TimerSink + 'a>>

Implementations

impl<'a> Timer<'a>

pub fn new<S: Into<String>>(raw_name: S) -> Timer<'a>

pub fn new_with_sink(name: &str, sink: Box<dyn TimerSink + 'a>) -> Timer<'a>

pub fn throwaway() -> Timer<'a>

fn println(&mut self, line: String)

fn selfless_println(
    maybe_sink: &mut Option<Box<dyn TimerSink + 'a>>,
    line: String
)

pub fn note(&mut self, line: String)

Log immediately, but also repeat at the end, to avoid having to scroll up and find interesting debug stuff.

pub fn warn(&mut self, line: String)

pub fn error(&mut self, line: String)

pub fn done(self)

Used to end the scope of a timer early.

pub fn start<S: Into<String>>(&mut self, raw_name: S)

pub fn stop<S: Into<String>>(&mut self, raw_name: S)

pub fn start_iter<S: Into<String>>(&mut self, raw_name: S, total_items: usize)

pub fn next(&mut self)

pub fn cancel_iter_early(&mut self)

pub(crate) fn add_result(&mut self, elapsed: f64, line: String)

pub fn parallelize<I, O, F: Fn(I) -> O>(
    &mut self,
    timer_name: &str,
    parallelism: Parallelism,
    requests: Vec<I>,
    cb: F
) -> Vec<O> where
    I: Send,
    O: Send,
    F: Send + Clone + Copy, 

The order of the result is deterministic / matches the input.

pub fn read_file(&mut self, path: &str) -> Result<(), Error>

Then the caller passes this in as a reader

Trait Implementations

impl<'a> Drop for Timer<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> Read for Timer<'a>

fn read(&mut self, buf: &mut [u8]) -> Result<usize, Error>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.