123456789_123456789_123456789_123456789_123456789_

Class: Benchmark::Report

Do not use. This class is for internal use only.
Relationships & Source Files
Inherits: Object
Defined in: lib/benchmark.rb

Overview

This class is used by the benchmark and bm methods. It is of little direct interest to the user.

Class Method Summary

Instance Attribute Summary

  • #format readonly

    An array of Tms objects representing each item.

  • #list readonly

    An array of Tms objects representing each item.

  • #width readonly

    An array of Tms objects representing each item.

Instance Method Summary

Constructor Details

.new(width = 0, format = nil) ⇒ Report

Returns an initialized Report instance. Usually, one doesn’t call this method directly, as new Report objects are created by the Benchmark#benchmark and Benchmark#bm methods. #width and #format are the label offset and format string used by Tms#format.

[ GitHub ] 

  


# File 'lib/benchmark.rb', line 379



def initialize(width = 0, format = nil)
  @width, @format, @list = width, format, []
end


  







Instance Attribute Details



  

    #format   (readonly)
  



  

    

An array of Tms objects representing each item.


  



  [ GitHub ]


  

  


# File 'lib/benchmark.rb', line 398



attr_reader :width, :format, :list


  








  

    #list   (readonly)
  



  

    

An array of Tms objects representing each item.


  



  [ GitHub ]


  

  


# File 'lib/benchmark.rb', line 398



attr_reader :width, :format, :list


  








  

    #width   (readonly)
  



  

    

An array of Tms objects representing each item.


  



  [ GitHub ]


  

  


# File 'lib/benchmark.rb', line 398



attr_reader :width, :format, :list


  







Instance Method Details



  

    #item(label = "", *format, &blk)  
    Also known as: #report
  



  

    

Prints the label and measured time for the block, formatted by #format. See Tms#format for the formatting rules.


  



  [ GitHub ]


  

  


# File 'lib/benchmark.rb', line 388



def item(label = "", *format, &blk) # :yield:
  w = label.to_s.length
  @width = w if @width < w
  @list << res = Benchmark.measure(label, &blk)
  res
end


  








  

    #report(label = "", *format, &blk)  
  



  

    

Alias for #item.


  



  [ GitHub ]


  

  


# File 'lib/benchmark.rb', line 395



alias report item