Class: Benchmark::Memory::Job::IOOutput::MetricFormatter

Inherits:

Object

• Object
• Benchmark::Memory::Job::IOOutput::MetricFormatter

Includes:

Helpers

Defined in:

lib/benchmark/memory/job/io_output/metric_formatter.rb

Overview

Format metrics for use with the IOOutput.

Instance Attribute Summary

• #metric ⇒ Metric readonly

  The metric to format.

Instance Method Summary

• #initialize(metric) ⇒ MetricFormatter constructor

  Instantiate a formatter to output a metric into an IO.

• #to_s ⇒ String

  Format metric to a string to put on the output.

Methods included from Helpers

#rjust, scale

Constructor Details

#initialize(metric) ⇒ MetricFormatter

Instantiate a formatter to output a metric into an IO.

Parameters:

• metric (Measurement::Metric) —

  The metric to format.

# File 'lib/benchmark/memory/job/io_output/metric_formatter.rb', line 16

def initialize(metric)
  @metric = metric
end

Instance Attribute Details

#metric ⇒ Metric (readonly)

Returns The metric to format.

Returns:

• (Metric) —

  The metric to format.

# File 'lib/benchmark/memory/job/io_output/metric_formatter.rb', line 21

def metric
  @metric
end

Instance Method Details

#to_s ⇒ String

Format metric to a string to put on the output.

Returns:

• (String)

# File 'lib/benchmark/memory/job/io_output/metric_formatter.rb', line 26

def to_s
  [allocated_message, retained_message].join(' ')
end