Module rb_sys::macros

source · [−]
Expand description

Definitions for the compiled Ruby macros.

Since macros are rely on the C preprocessor, they are not automatically available to Rust. This module compiles a tiny snippet of C code that is used to generate the Ruby macros, so they can be used in Rust.

Functions

ID2SYM⚠

Allocates an instance of ::rb_cSymbol that has the given id.

NIL_P⚠

Checks if the given object is nil.

RARRAY_LEN⚠

Queries the length of the array.

RARRAY_PTR⚠

Wild use of a C pointer. This function accesses the backend storage directly. This is slower than #RARRAY_PTR_USE_TRANSIENT. It exercises extra manoeuvres to protect our generational GC. Use of this function is considered archaic. Use a modern way instead. @param[in] ary An object of ::RArray. @return The backend C array. @internal That said… there are extension libraries in the wild who uses it. We cannot but continue supporting.

RB_FLOAT_TYPE_P⚠

Queries if the object is an instance of ::ruby_macros_cFloat.

RB_INTEGER_TYPE_P⚠

Queries if the object is an instance of ::ruby_macros_cInteger.

RB_TEST⚠

Emulates Ruby’s “if” statement.

RB_TYPE_P⚠

Queries if the given object is of given type.

RSTRING_LEN⚠

Queries the length of the string.

RSTRING_PTR⚠

Queries the contents pointer of the string.

SYM2ID⚠

Converts an instance of ::rb_cSymbol into an ::ID.

SYMBOL_P⚠

Queries if the object is an instance of ::ruby_macros_cSymbol.