rfile.h File Reference

Defines struct RFile. More...

#include "ruby/internal/core/rbasic.h"
#include "ruby/internal/cast.h"

Go to the source code of this file.

Data Structures
struct	RFile
	Ruby's File and IO. More...

Macros
#define	RFILE(obj)
	Convenient casting macro.

Detailed Description

Defines struct RFile.

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

Macro Definition Documentation

RFILE

#define RFILE

(

obj

)

Value:

RBIMPL_CAST((struct RFile *)(obj))

Convenient casting macro.

Parameters

obj	An object, which is in fact an RFile.

Returns

The passed object casted to RFile.

Definition at line 50 of file rfile.h.

Referenced by rb_io_closed_p(), rb_io_descriptor(), rb_io_maybe_wait(), rb_io_open_descriptor(), and rb_io_path().