Trait metrix::PutsSnapshot [−] [src]

pub trait PutsSnapshot {
    fn put_snapshot(&self, into: &mut Snapshot, descriptive: bool);
}

Implementors are able to writ thier snapshot into the given snapshot.

Guidelines for writing snapshots:

  • A PutsSnapshot that has a name should create a new sub snapshot and add its values there

  • A PutsSnapshot that does not have a name should add its values directly to the given snapshot

  • When descriptive is set to true PutsSnapshot should put its title and description into the same Snapshot it put its values(exception: instruments) thereby not overwriting already existing descriptions so that the more general top level ones survive.

  • When descriptive is set to true on an instrument the instrument should put its description into the snapshot it got passed therby adding the suffixes "_title" and "_description" to its name.

Required Methods

Puts the current snapshot values into the given Snapshot thereby following the guidelines of PutsSnapshot.

Implementors