Last Modified
2015-10-03 10:22:32 -0500


C API Reference

This is a C API Reference. The structure of this document will follow the directory structure of include/ directory.

Headers list

Header name|Features ———–|——– mrbconf.h|Defines macros for mruby configurations. mruby.h|Main header of mruby C API. Include this first. mruby/array.h|Array class. mruby/class.h|Class class. mruby/compile.h|mruby compiler. mruby/data.h|User defined object. mruby/debug.h|Debugging. mruby/dump.h|Dumping compiled mruby script. mruby/error.h|Error handling. mruby/gc.h|Uncommon memory management stuffs. mruby/hash.h|Hash class. mruby/irep.h|Compiled mruby script. mruby/khash.h|Defines of khash which is used in hash table of mruby. mruby/numeric.h|Numeric class and sub-classes of it. mruby/opode.h|Operation codes used in mruby VM. mruby/proc.h|Proc class. mruby/range.h|Range class. mruby/re.h|Regexp class. mruby/string.h|String class. mruby/value.h|mrb_value functions and macros. mruby/variable.h|Functions to access to mruby variables. mruby/version.h|Macros of mruby version.

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit

blog comments powered by Disqus