Ruby: include/ruby/internal/core/robject.h File Reference

Ruby 3.0.5p211 (2022-11-24 revision ba5cf0f7c52d4d35cc6a173c89eda98ceffa2dcf)

Data Structures | Macros | Enumerations
robject.h File Reference

Defines struct RObject. More...

`#include "ruby/internal/config.h"`
`#include "ruby/internal/attr/artificial.h"`
`#include "ruby/internal/attr/deprecated.h"`
`#include "ruby/internal/attr/pure.h"`
`#include "ruby/internal/cast.h"`
`#include "ruby/internal/fl_type.h"`
`#include "ruby/internal/value.h"`
`#include "ruby/internal/value_type.h"`

Go to the source code of this file.

## Data Structures
struct | RObject

## Macros
#define | ROBJECT(obj) RBIMPL_CAST((struct RObject *)(obj))
#define | ROBJECT_EMBED_LEN_MAX ROBJECT_EMBED_LEN_MAX
#define | ROBJECT_EMBED ROBJECT_EMBED

## Enumerations
enum | ruby_robject_flags { ROBJECT_EMBED = RUBY_FL_USER1 }
enum | ruby_robject_consts { ROBJECT_EMBED_LEN_MAX = RBIMPL_EMBED_LEN_MAX_OF(VALUE) }

## Detailed Description

Defines struct RObject.

Author
  Ruby developers ruby-.nosp@m.core.nosp@m.@ruby.nosp@m.-lan.nosp@m.g.org

Copyright
  This file is a part of the programming language Ruby. Permission is hereby granted, to either redistribute and/or modify this file, provided that the conditions mentioned in the file COPYING are met. Consult the file for details.

Warning
  Symbols prefixed with either `RBIMPL` or `rbimpl` are implementation details. Don't take them as canon. They could rapidly appear then vanish. The name (path) of this header file is also an implementation detail. Do not expect it to persist at the place it is now. Developers are free to move it anywhere anytime at will.

Note
  To ruby-core: remember that this header can be possibly recursively included from extension libraries written in C++. Do not expect for instance `__VA_ARGS__` is always available. We assume C99 for ruby itself but we don't assume languages of extension libraries. They could be written in C++98.

Definition in file robject.h.

## Macro Definition Documentation

## ◆ ROBJECT

#define ROBJECT | ( |  | obj | ) | RBIMPL_CAST((struct RObject *)(obj))

Definition at line 37 of file robject.h.

## ◆ ROBJECT_EMBED

#define ROBJECT_EMBED ROBJECT_EMBED

Definition at line 39 of file robject.h.

## ◆ ROBJECT_EMBED_LEN_MAX

#define ROBJECT_EMBED_LEN_MAX ROBJECT_EMBED_LEN_MAX

Definition at line 38 of file robject.h.

## Enumeration Type Documentation

## ◆ ruby_robject_consts

enum ruby_robject_consts

Enumerator
ROBJECT_EMBED_LEN_MAX |

Definition at line 48 of file robject.h.

## ◆ ruby_robject_flags

enum ruby_robject_flags

Enumerator
ROBJECT_EMBED |

Definition at line 46 of file robject.h.