A wrapper for ruby's Symbol class. More...
#include <Symbol.hpp>
Inheritance diagram for Rice::Symbol:
Public Member Functions | |
| Symbol (VALUE v) | |
| Wrap an existing symbol. | |
| Symbol (Object v) | |
| Wrap an existing symbol. | |
| Symbol (Identifier id) | |
| Construct a Symbol from an Identifier. | |
| Symbol (char const *s="") | |
| Construct a Symbol from a null-terminated C string. | |
| Symbol (std::string const &s) | |
| Construct a Symbol from an std::string. | |
| char const * | c_str () const |
| Return a string representation of the Symbol. | |
| std::string | str () const |
| Return a string representation of the Symbol. | |
| Identifier | to_id () const |
| Return the Symbol as an Identifier. | |
 Public Member Functions inherited from Rice::Object | |
| Object (VALUE value=Qnil) | |
| Encapsulate an existing ruby object. | |
| Object (Object const &other) | |
| Copy constructor. | |
| virtual | ~Object () |
| Destructor. | |
| bool | test () const |
| operator bool () const | |
| bool | is_nil () const |
| Returns true if the object is nil, false otherwise. | |
| operator VALUE () const | |
| Implicit conversion to VALUE. | |
| VALUE const volatile & | value () const |
| Explicitly get the encapsulated VALUE. | |
| Class | class_of () const |
| Get the class of an object. More... | |
| int | compare (Object const &other) const |
| Compare this object to another object. More... | |
| String | to_s () const |
| Return a string representation of an object. More... | |
| String | inspect () const |
| Inspect the object. More... | |
| void | freeze () |
| Freeze the object. | |
| bool | is_frozen () const |
| Determine if the object is frozen. More... | |
| void | swap (Object &other) |
| Swap with another Object. | |
| Object | instance_eval (String const &s) |
| Evaluate the given string in the context of the object. More... | |
| int | rb_type () const |
| Return the type of the underlying C object. More... | |
| bool | is_a (Object klass) const |
| Determine whether the object is an instance of a class/module. More... | |
| bool | respond_to (Identifier id) const |
| Determine if the objects responds to a method. More... | |
| bool | is_instance_of (Object klass) const |
| Determine whether class is the object's class. More... | |
| template<typename T > | |
| void | iv_set (Identifier name, T const &value) |
| Set an instance variable. More... | |
| Object | iv_get (Identifier name) const |
| Get the value of an instance variable. More... | |
| Object | attr_get (Identifier name) const |
| Get the value of an instance variable, but don't warn if it is. More... | |
| template<typename ... ArgT> | |
| Object | call (Identifier id, ArgT... args) const |
| Call the Ruby method specified by 'id' on object 'obj'. More... | |
| Object | vcall (Identifier id, Array args) |
| Vectorized call. More... | |
| void | mark () const |
| Mark the object with the garbage collector. | |
Additional Inherited Members | |
| Protected Member Functions inherited from Rice::Object | |
| void | set_value (VALUE v) |
| Set the encapsulated value. | |
| template<typename ... ArgT> | |
| std::vector< VALUE > | convert_args (ArgT &... args) const |
| Unpack the provided arguments and convert them all to Ruby types. | |
Detailed Description
A wrapper for ruby's Symbol class.
Symbols are internal identifiers in ruby. They are singletons and can be thought of as frozen strings. They differ from an Identifier in that they are in fact real Objects, but they can be converted back and forth between Identifier and Symbol.
The documentation for this class was generated from the following file:
