mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
d0a7189f26
RDoc says `ObjectSpace.dump(obj, output: :stdout) # => nil`,
but it returns STDOUT since fbba6bd4e3.
I think it is unintentional change.
91 lines
2.7 KiB
Ruby
91 lines
2.7 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'objspace.so'
|
|
|
|
module ObjectSpace
|
|
class << self
|
|
private :_dump
|
|
private :_dump_all
|
|
end
|
|
|
|
module_function
|
|
|
|
# call-seq:
|
|
# ObjectSpace.dump(obj[, output: :string]) # => "{ ... }"
|
|
# ObjectSpace.dump(obj, output: :file) # => #<File:/tmp/rubyobj20131125-88733-1xkfmpv.json>
|
|
# ObjectSpace.dump(obj, output: :stdout) # => nil
|
|
#
|
|
# Dump the contents of a ruby object as JSON.
|
|
#
|
|
# This method is only expected to work with C Ruby.
|
|
# This is an experimental method and is subject to change.
|
|
# In particular, the function signature and output format are
|
|
# not guaranteed to be compatible in future versions of ruby.
|
|
def dump(obj, output: :string)
|
|
out = case output
|
|
when :file, nil
|
|
require 'tempfile'
|
|
Tempfile.create(%w(rubyobj .json))
|
|
when :stdout
|
|
STDOUT
|
|
when :string
|
|
+''
|
|
when IO
|
|
output
|
|
else
|
|
raise ArgumentError, "wrong output option: #{output.inspect}"
|
|
end
|
|
|
|
ret = _dump(obj, out)
|
|
return nil if output == :stdout
|
|
ret
|
|
end
|
|
|
|
|
|
# call-seq:
|
|
# ObjectSpace.dump_all([output: :file]) # => #<File:/tmp/rubyheap20131125-88469-laoj3v.json>
|
|
# ObjectSpace.dump_all(output: :stdout) # => nil
|
|
# ObjectSpace.dump_all(output: :string) # => "{...}\n{...}\n..."
|
|
# ObjectSpace.dump_all(output:
|
|
# File.open('heap.json','w')) # => #<File:heap.json>
|
|
# ObjectSpace.dump_all(output: :string,
|
|
# since: 42) # => "{...}\n{...}\n..."
|
|
#
|
|
# Dump the contents of the ruby heap as JSON.
|
|
#
|
|
# _since_ must be a non-negative integer or +nil+.
|
|
#
|
|
# If _since_ is a positive integer, only objects of that generation and
|
|
# newer generations are dumped. The current generation can be accessed using
|
|
# GC::count.
|
|
#
|
|
# Objects that were allocated without object allocation tracing enabled
|
|
# are ignored. See ::trace_object_allocations for more information and
|
|
# examples.
|
|
#
|
|
# If _since_ is omitted or is +nil+, all objects are dumped.
|
|
#
|
|
# This method is only expected to work with C Ruby.
|
|
# This is an experimental method and is subject to change.
|
|
# In particular, the function signature and output format are
|
|
# not guaranteed to be compatible in future versions of ruby.
|
|
def dump_all(output: :file, full: false, since: nil)
|
|
out = case output
|
|
when :file, nil
|
|
require 'tempfile'
|
|
Tempfile.create(%w(rubyheap .json))
|
|
when :stdout
|
|
STDOUT
|
|
when :string
|
|
+''
|
|
when IO
|
|
output
|
|
else
|
|
raise ArgumentError, "wrong output option: #{output.inspect}"
|
|
end
|
|
|
|
ret = _dump_all(out, full, since)
|
|
return nil if output == :stdout
|
|
ret
|
|
end
|
|
end
|