db/d6c/include_2ruby_2internal_2intern_2struct_8h_source.html

#ifndef RBIMPL_INTERN_STRUCT_H                       /*-*-C++-*-vi:se ft=cpp:*/

#define RBIMPL_INTERN_STRUCT_H

#include "ruby/internal/attr/nonnull.h"

#include "ruby/internal/dllexport.h"

#include "ruby/internal/intern/vm.h" /* rb_alloc_func_t */

#include "ruby/internal/value.h"


RBIMPL_SYMBOL_EXPORT_BEGIN()


/* struct.c */


VALUE rb_struct_new(VALUE klass, ...);


VALUE rb_struct_define(const char *name, ...);


RBIMPL_ATTR_NONNULL((2))

VALUE rb_struct_define_under(VALUE space, const char *name, ...);


VALUE rb_struct_alloc(VALUE klass, VALUE values);


VALUE rb_struct_initialize(VALUE self, VALUE values);


VALUE rb_struct_getmember(VALUE self, ID key);


VALUE rb_struct_s_members(VALUE klass);


VALUE rb_struct_members(VALUE self);


VALUE rb_struct_alloc_noinit(VALUE klass);


VALUE rb_struct_define_without_accessor(const char *name, VALUE super, rb_alloc_func_t func, ...);


RBIMPL_ATTR_NONNULL((2))

VALUE rb_struct_define_without_accessor_under(VALUE outer, const char *class_name, VALUE super, rb_alloc_func_t alloc, ...);


VALUE rb_data_define(VALUE super, ...);


RBIMPL_SYMBOL_EXPORT_END()


#endif /* RBIMPL_INTERN_STRUCT_H */

dllexport.h
Tweaking visibility of C variables/functions.

RBIMPL_SYMBOL_EXPORT_END
#define RBIMPL_SYMBOL_EXPORT_END()
Counterpart of RBIMPL_SYMBOL_EXPORT_BEGIN.
Definition dllexport.h:74

RBIMPL_SYMBOL_EXPORT_BEGIN
#define RBIMPL_SYMBOL_EXPORT_BEGIN()
Shortcut macro equivalent to RUBY_SYMBOL_EXPORT_BEGIN extern "C" {.
Definition dllexport.h:65

rb_struct_define_without_accessor_under
VALUE rb_struct_define_without_accessor_under(VALUE outer, const char *class_name, VALUE super, rb_alloc_func_t alloc,...)
Identical to rb_struct_define_without_accessor(), except it defines the class under the specified nam...
Definition struct.c:459

rb_struct_define_under
VALUE rb_struct_define_under(VALUE space, const char *name,...)
Identical to rb_struct_define(), except it defines the class under the specified namespace instead of...
Definition struct.c:505

rb_struct_new
VALUE rb_struct_new(VALUE klass,...)
Creates an instance of the given struct.
Definition struct.c:842

rb_struct_initialize
VALUE rb_struct_initialize(VALUE self, VALUE values)
Mass-assigns a struct's fields.
Definition struct.c:794

rb_struct_define_without_accessor
VALUE rb_struct_define_without_accessor(const char *name, VALUE super, rb_alloc_func_t func,...)
Identical to rb_struct_define(), except it does not define accessor methods.
Definition struct.c:472

rb_struct_define
VALUE rb_struct_define(const char *name,...)
Defines a struct class.
Definition struct.c:485

rb_struct_alloc
VALUE rb_struct_alloc(VALUE klass, VALUE values)
Identical to rb_struct_new(), except it takes the field values as a Ruby array.
Definition struct.c:836

rb_data_define
VALUE rb_data_define(VALUE super,...)
Defines an anonymous data class.
Definition struct.c:1699

rb_struct_alloc_noinit
VALUE rb_struct_alloc_noinit(VALUE klass)
Allocates an instance of the given class.
Definition struct.c:405

rb_struct_s_members
VALUE rb_struct_s_members(VALUE klass)
Queries the list of the names of the fields of the given struct class.
Definition struct.c:67

rb_struct_members
VALUE rb_struct_members(VALUE self)
Queries the list of the names of the fields of the class of the given struct object.
Definition struct.c:81

rb_struct_getmember
VALUE rb_struct_getmember(VALUE self, ID key)
Identical to rb_struct_aref(), except it takes ID instead of VALUE.
Definition struct.c:232

vm.h
Public APIs related to rb_cRubyVM.

rb_alloc_func_t
VALUE(* rb_alloc_func_t)(VALUE klass)
This is the type of functions that ruby calls when trying to allocate an object.
Definition vm.h:216

nonnull.h
Defines RBIMPL_ATTR_NONNULL.

RBIMPL_ATTR_NONNULL
#define RBIMPL_ATTR_NONNULL(list)
Wraps (or simulates) __attribute__((nonnull))
Definition nonnull.h:30

value.h
Defines VALUE and ID.

ID
uintptr_t ID
Type that represents a Ruby identifier such as a variable name.
Definition value.h:52

VALUE
uintptr_t VALUE
Type that represents a Ruby object.
Definition value.h:40