enum.h File Reference

(37a72b0150ec36b4ea27175039afc28c62207b0c)

Public APIs related to rb_mEnumerable. More...

#include "ruby/internal/dllexport.h"
#include "ruby/internal/value.h"

Include dependency graph for enum.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
VALUE	rb_enum_values_pack (int argc, const VALUE *argv)
	Basically identical to rb_ary_new_form_values(), except it returns something different when argc < 2. More...

Detailed Description

Public APIs related to rb_mEnumerable.

Author

Ruby developers ruby-.nosp@m.core.nosp@m.@ruby.nosp@m.-lan.nosp@m.g.org

Copyright

This file is a part of the programming language Ruby. Permission is hereby granted, to either redistribute and/or modify this file, provided that the conditions mentioned in the file COPYING are met. Consult the file for details.

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

Function Documentation

rb_enum_values_pack()

VALUE rb_enum_values_pack	(	int	argc,
		const VALUE *	argv
	)

Basically identical to rb_ary_new_form_values(), except it returns something different when argc < 2.

Parameters

[in]	argc	Number of objects of argv.
[in]	argv	Arbitrary objects.

Return values

RUBY_Qnil	argc is zero.
argv[0]	argc is one.
otherwise	Otherwise.

Definition at line 53 of file enum.c.