RArray Struct Reference

Ruby's array. More...

#include <rarray.h>

Data Fields
struct RBasic	basic
	Basic part, including flags and class.
union {
struct {
rb_len_t   len
	Number of elements of the array. More...
union {
rb_len_t   capa
	Capacity of *ptr. More...
const VALUE   shared_root
	Parent of the array. More...
}   aux
	Auxiliary info. More...
const VALUE *   ptr
	Pointer to the C array that holds the elements of the array. More...
}   heap
	Arrays that use separated memory region for elements use this pattern. More...
const VALUE   ary [1]
	Embedded elements. More...
}	as
	Array's specific fields.

Detailed Description

Ruby's array.

Definition at line 127 of file rarray.h.

Field Documentation

ary

const VALUE RArray::ary[1]

Embedded elements.

When an array is short enough, it uses this area to store its elements. In this case the length is encoded into the flags.

Definition at line 187 of file rarray.h.

[union]

union { ... } RArray::as

Array's specific fields.

[union]

union { ... } RArray::aux

Auxiliary info.

basic

struct RBasic RArray::basic

Basic part, including flags and class.

Definition at line 130 of file rarray.h.

capa

rb_len_t RArray::capa

Capacity of *ptr.

A continuous memory region of at least capa elements is expected to exist at *ptr. This can be bigger than len.

Definition at line 152 of file rarray.h.

[struct]

struct { ... } RArray::heap

Arrays that use separated memory region for elements use this pattern.

len

rb_len_t RArray::len

Number of elements of the array.

Definition at line 142 of file rarray.h.

ptr

const VALUE* RArray::ptr

Pointer to the C array that holds the elements of the array.

In the old days each array had dedicated memory regions. That is no longer true today, but there still are arrays of such properties. This field could be used to point such things.

Definition at line 174 of file rarray.h.

shared_root

const VALUE RArray::shared_root

Parent of the array.

Nowadays arrays can share their backend memory regions each other, constructing gigantic nest of objects. This situation is called "shared", and this is the field to control such properties.

Definition at line 165 of file rarray.h.

---

The documentation for this struct was generated from the following file:

• include/ruby/internal/core/rarray.h (05917fd1e6d8539db013b087d4ea93cf068038e1)