Ruby  3.4.0dev (2024-12-06 revision 892c46283a5ea4179500d951c9d4866c0051f27b)
Macros | Functions
st_data_t.h File Reference

(892c46283a5ea4179500d951c9d4866c0051f27b)

Arithmetic conversion between C's st_data_t and Ruby's. More...

#include "ruby/internal/arithmetic/fixnum.h"
#include "ruby/internal/arithmetic/long.h"
#include "ruby/internal/attr/artificial.h"
#include "ruby/internal/attr/const.h"
#include "ruby/internal/attr/constexpr.h"
#include "ruby/internal/cast.h"
#include "ruby/internal/value.h"
#include "ruby/assert.h"
#include "ruby/st.h"
Include dependency graph for st_data_t.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define ST2FIX   RB_ST2FIX
 Old name of RB_ST2FIX. More...
 

Functions

static VALUE RB_ST2FIX (st_data_t i)
 Converts a C's st_data_t into an instance of rb_cInteger. More...
 

Detailed Description

Arithmetic conversion between C's st_data_t and Ruby's.

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 st_data_t.h.

Function Documentation

◆ RB_ST2FIX()

static VALUE RB_ST2FIX ( st_data_t  i)
inlinestatic

Converts a C's st_data_t into an instance of rb_cInteger.

Parameters
[in]iThe data in question.
Returns
A converted result
Warning
THIS CONVERSION LOSES DATA! Be warned.
See also
https://bugs.ruby-lang.org/issues/13877
https://bugs.ruby-lang.org/issues/14218

Definition at line 59 of file st_data_t.h.