Struct rutie::Symbol

pub struct Symbol { /* fields omitted */ }

Symbol

Methods

impl Symbol

pub fn new(string: &str) -> Self

Creates a new instance of Ruby Symbol.

Examples

use rutie::{Symbol, VM};

let symbol = Symbol::new("hello");

assert_eq!(symbol.to_str(), "hello");

Ruby:

sym = :hello

sym.to_s == 'hello'

pub fn to_str(&self) -> &str

Retrieves the Rust &str corresponding to Symbol object (Ruby Symbol#to_s).

Examples

use rutie::{Symbol, VM};

let symbol = Symbol::new("hello");

assert_eq!(symbol.to_str(), "hello");

Ruby:

sym = :hello

sym.to_s == 'hello'

pub fn to_string(&self) -> String

Retrieves the Rust String corresponding to Symbol object (Ruby Symbol#to_s).

Examples

use rutie::{Symbol, VM};

let symbol = Symbol::new("hello");

assert_eq!(symbol.to_string(), "hello");

Ruby:

sym = :hello

sym.to_s == 'hello'

pub fn to_proc(&self) -> Proc

Converts Symbol to Proc

Examples

use rutie::{Symbol, Proc, VM, VerifiedObject};

let symbol = Symbol::new("hello");

assert!(Proc::is_correct_type(&symbol.to_proc()), "not correct type!");

Ruby:

sym = :hello

sym.to_s == 'hello'

Trait Implementations

impl Object for Symbol

fn value(&self) -> Value

Returns internal value of current object.

fn class(&self) -> Class

Returns a class of current object.

fn singleton_class(&self) -> Class

Returns a singleton class of current object.

fn get_data<'a, T>(&'a self, wrapper: &'a dyn DataTypeWrapper<T>) -> &T

Gets an immutable reference to the Rust structure which is wrapped into a Ruby object.

fn get_data_mut<'a, T>(
    &'a mut self,
    wrapper: &'a dyn DataTypeWrapper<T>
) -> &mut T

Gets a mutable reference to the Rust structure which is wrapped into a Ruby object.

fn define<F: Fn(&mut Self)>(&mut self, f: F) -> &Self

Wraps calls to the object.

fn define_method<I: Object, O: Object>(
    &mut self,
    name: &str,
    callback: Callback<I, O>
)

Defines an instance method for the given class or object.

fn define_private_method<I: Object, O: Object>(
    &mut self,
    name: &str,
    callback: Callback<I, O>
)

Defines a private instance method for the given class or object.

fn define_singleton_method<I: Object, O: Object>(
    &mut self,
    name: &str,
    callback: Callback<I, O>
)

Defines a class method for given class or singleton method for object.

fn def<I: Object, O: Object>(&mut self, name: &str, callback: Callback<I, O>)

An alias for define_method (similar to Ruby syntax def some_method).

fn def_private<I: Object, O: Object>(
    &mut self,
    name: &str,
    callback: Callback<I, O>
)

An alias for define_private_method (similar to Ruby syntax private def some_method).

fn def_self<I: Object, O: Object>(
    &mut self,
    name: &str,
    callback: Callback<I, O>
)

An alias for define_singleton_method (similar to Ruby def self.some_method).

unsafe fn send(&self, method: &str, arguments: &[AnyObject]) -> AnyObject

Calls a given method on an object similarly to Ruby Object#send method

fn equals<T: Object>(&self, other: &T) -> bool

Alias for Ruby's ==

fn case_equals<T: Object>(&self, other: &T) -> bool

Alias for Ruby's ===

fn is_eql<T: Object>(&self, other: &T) -> bool

Alias for Ruby's eql?

fn is_equal<T: Object>(&self, other: &T) -> bool

Alias for Ruby's equal?

fn respond_to(&self, method: &str) -> bool

Checks whether the object responds to given method

fn protect_send(
    &self,
    method: &str,
    arguments: &[AnyObject]
) -> Result<AnyObject, AnyException>

protect_send returns Result<AnyObject, AnyObject>

fn protect_public_send(
    &self,
    method: &str,
    arguments: &[AnyObject]
) -> Result<AnyObject, AnyException>

protect_public_send returns Result<AnyObject, AnyObject>

fn is_nil(&self) -> bool

Checks whether the object is nil

fn to_any_object(&self) -> AnyObject

Converts struct to AnyObject

fn instance_variable_get(&self, variable: &str) -> AnyObject

Gets an instance variable of object

fn instance_variable_set<T: Object>(
    &mut self,
    variable: &str,
    value: T
) -> AnyObject

Sets an instance variable for object

fn is_frozen(&self) -> bool

Returns the freeze status of the object.

fn freeze(&mut self) -> Self

Prevents further modifications to the object.

unsafe fn to<T: Object>(&self) -> T

Unsafely casts current object to the specified Ruby type

fn try_convert_to<T: VerifiedObject>(&self) -> Result<T, AnyException>

Safely casts current object to the specified Ruby type

fn ty(&self) -> ValueType

Determines the value type of the object

impl VerifiedObject for Symbol

fn is_correct_type<T: Object>(object: &T) -> bool

fn error_message() -> &'static str

impl From<Value> for Symbol

fn from(value: Value) -> Self

Performs the conversion.

impl Into<Value> for Symbol

fn into(self) -> Value

Performs the conversion.

impl Into<AnyObject> for Symbol

fn into(self) -> AnyObject

Performs the conversion.

impl PartialEq<Symbol> for Symbol

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Debug for Symbol

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.