Class: Timify::Trace

Inherits:

Object

• Object
• Timify::Trace

Defined in:

lib/timify/trace.rb

Overview

Result of trace: the block's return value and the timer used to measure it.

Instance Attribute Summary

• #timer ⇒ Timify readonly

  The timer created for the block.

• #value ⇒ Object readonly

  The block's return value.

Instance Method Summary

• #initialize(value:, timer:) ⇒ Trace constructor

  A new instance of Trace.

• #totals(**options) ⇒ Hash, String

  Delegates to #totals on #timer.

Constructor Details

#initialize(value:, timer:) ⇒ Trace

Returns a new instance of Trace.

Parameters:

• value (Object)
• timer (Timify)

# File 'lib/timify/trace.rb', line 14

def initialize(value:, timer:)
  @value = value
  @timer = timer
end

Instance Attribute Details

#timer ⇒ Timify (readonly)

Returns the timer created for the block.

Returns:

• (Timify) —

  the timer created for the block

# File 'lib/timify/trace.rb', line 10

def timer
  @timer
end

#value ⇒ Object (readonly)

Returns the block's return value.

Returns:

• (Object) —

  the block's return value

# File 'lib/timify/trace.rb', line 7

def value
  @value
end

Instance Method Details

#totals(**options) ⇒ Hash, String

Delegates to Timify#totals on #timer.

Parameters:

• options (Hash) —

  keyword arguments accepted by Timify#totals

Returns:

• (Hash, String)

# File 'lib/timify/trace.rb', line 23

def totals(**options)
  @timer.totals(**options)
end