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

[DOC] Improve docs for ObjectSpace.count_imemo_objects

Browse Source
This commit is contained in:
Peter Zhu 2026-01-06 19:06:13 -05:00
parent cf5c5abe1e
commit 1267a3ab56
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 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
ext/objspace/objspace.c
View File

@ -419,28 +419,22 @@ count_imemo_objects_i(VALUE v, void *data)
/*
* call-seq:
* ObjectSpace.count_imemo_objects([result_hash]) -> hash
* ObjectSpace.count_imemo_objects(result_hash = nil) -> hash
*
* Counts objects for each +T_IMEMO+ type.
* Returns a hash containing the number of objects for each +T_IMEMO+ type.
* The keys are Symbol objects of the +T_IMEMO+ type name.
* +T_IMEMO+ objects are Ruby internal objects that are not visible to Ruby
* programs.
*
* This method is only for MRI developers interested in performance and memory
* usage of Ruby programs.
* ObjectSpace.count_imemo_objects
* # => {imemo_callcache: 5482, imemo_constcache: 1258, imemo_ment: 13906, ... }
*
* 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.
*
* {:imemo_ifunc=>8,
* :imemo_svar=>7,
* :imemo_cref=>509,
* :imemo_memo=>1,
* :imemo_throw_data=>1}
*
* 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 symbol objects.
* 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.
*/