mirror/ruby
1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2026-01-26 12:14:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOC] Improve docs for ObjectSpace.count_tdata_objects

Browse Source
This commit is contained in:
Peter Zhu 2026-01-06 17:24:45 -05:00
parent 8baaece6d9
commit cf5c5abe1e
Notes: git 2026-01-11 15:47:28 +00:00 
Merged: https://github.com/ruby/ruby/pull/15820
1 changed files with 12 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
ext/objspace/objspace.c
View File

@ -365,32 +365,22 @@ cto_i(VALUE v, void *data)
/*
* call-seq:
* ObjectSpace.count_tdata_objects([result_hash]) -> hash
* ObjectSpace.count_tdata_objects(result_hash = nil) -> hash
*
* Counts objects for each +T_DATA+ type.
* Returns a hash containing the number of objects for each +T_DATA+ type.
* The keys are Class objects when the +T_DATA+ object has an associated class,
* or Symbol objects of the name defined in the +rb_data_type_struct+ for internal
* +T_DATA+ objects.
*
* This method is only for MRI developers interested in performance and memory
* usage of Ruby programs.
* ObjectSpace.count_tdata_objects
* # => {RBS::Location => 39255, marshal_compat_table: 1, Encoding => 103, mutex: 1, ... }
*
* It returns a hash as:
* If the optional argument +result_hash+ is given, it is overwritten and
* returned. This is intended to avoid the probe effect.
*
* {RubyVM::InstructionSequence=>504, :parser=>5, :barrier=>6,
* :mutex=>6, Proc=>60, RubyVM::Env=>57, Mutex=>1, Encoding=>99,
* ThreadGroup=>1, Binding=>1, Thread=>1, RubyVM=>1, :iseq=>1,
* Random=>1, ARGF.class=>1, Data=>1, :autoload=>3, Time=>2}
* # T_DATA objects existing at startup on r32276.
*
* If the optional argument, result_hash, is given, it is overwritten and
* returned. This is intended to avoid probe effect.
*
* The contents of the returned hash is implementation specific and may change
* in the future.
*
* In this version, keys are Class object or Symbol object.
*
* If object is kind of normal (accessible) object, the key is Class object.
* If object is not a kind of normal (internal) object, the key is symbol
* name, registered by rb_data_type_struct.
* This method is intended for developers interested in performance and memory
* usage of Ruby programs. The contents of the returned hash is implementation
* specific and may change in the future.
*
* This method is only expected to work with C Ruby.
*/