Ruby 3.0.5p211 (2022-11-24 revision ba5cf0f7c52d4d35cc6a173c89eda98ceffa2dcf)
Macros | Functions
rstruct.h File Reference

Routines to manipulate struct RStruct. More...

#include "ruby/internal/attr/artificial.h"
#include "ruby/internal/dllexport.h"
#include "ruby/internal/value.h"
#include "ruby/internal/value_type.h"
#include "ruby/internal/arithmetic/long.h"
#include "ruby/internal/arithmetic/int.h"
#include "ruby/backward.h"

Go to the source code of this file.

Macros

#define RSTRUCT_PTR(st)   rb_struct_ptr(st)
 

Functions

VALUE rb_struct_size (VALUE s)
 
VALUE rb_struct_aref (VALUE, VALUE)
 
VALUE rb_struct_aset (VALUE, VALUE, VALUE)
 

Detailed Description

Routines to manipulate struct RStruct.

Author
Ruby developers ruby-.nosp@m.core.nosp@m.@ruby.nosp@m.-lan.nosp@m.g.org
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 rstruct.h.

Macro Definition Documentation

◆ RSTRUCT_PTR

#define RSTRUCT_PTR (   st)    rb_struct_ptr(st)

Definition at line 33 of file rstruct.h.

Function Documentation

◆ rb_struct_aref()

VALUE rb_struct_aref ( VALUE  s,
VALUE  idx 
)

Definition at line 1096 of file struct.c.

References RSTRUCT_GET.

◆ rb_struct_aset()

VALUE rb_struct_aset ( VALUE  s,
VALUE  idx,
VALUE  val 
)

Definition at line 1123 of file struct.c.

References RSTRUCT_SET.

◆ rb_struct_size()

VALUE rb_struct_size ( VALUE  s)

Definition at line 1326 of file struct.c.

References LONG2FIX, and RSTRUCT_LEN.