1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
use std::{convert::From, hash::Hash, hash::Hasher};
use binding::symbol;
use types::{Value, ValueType};
use {Object, VerifiedObject, AnyObject, Proc};
/// `Symbol`
#[derive(Debug)]
#[repr(C)]
pub struct Symbol {
value: Value,
}
impl Symbol {
/// Creates a new instance of Ruby `Symbol`.
///
/// # Examples
///
/// ```
/// use rutie::{Symbol, VM};
/// # VM::init();
///
/// let symbol = Symbol::new("hello");
///
/// assert_eq!(symbol.to_str(), "hello");
/// ```
///
/// Ruby:
///
/// ```ruby
/// sym = :hello
///
/// sym.to_s == 'hello'
/// ```
pub fn new(string: &str) -> Self {
let id = symbol::internal_id(string);
Self::from(symbol::id_to_sym(id))
}
/// Retrieves the Rust `&str` corresponding to `Symbol` object (Ruby `Symbol#to_s`).
///
/// # Examples
///
/// ```
/// use rutie::{Symbol, VM};
/// # VM::init();
///
/// let symbol = Symbol::new("hello");
///
/// assert_eq!(symbol.to_str(), "hello");
/// ```
///
/// Ruby:
///
/// ```ruby
/// sym = :hello
///
/// sym.to_s == 'hello'
/// ```
pub fn to_str(&self) -> &str {
symbol::value_to_str(self.value())
}
/// Retrieves the Rust `String` corresponding to `Symbol` object (Ruby `Symbol#to_s`).
///
/// # Examples
///
/// ```
/// use rutie::{Symbol, VM};
/// # VM::init();
///
/// let symbol = Symbol::new("hello");
///
/// assert_eq!(symbol.to_string(), "hello");
/// ```
///
/// Ruby:
///
/// ```ruby
/// sym = :hello
///
/// sym.to_s == 'hello'
/// ```
pub fn to_string(&self) -> String {
symbol::value_to_string(self.value())
}
/// Converts `Symbol` to `Proc`
///
/// # Examples
///
/// ```
/// use rutie::{Symbol, Proc, VM, VerifiedObject};
/// # VM::init();
///
/// let symbol = Symbol::new("hello");
///
/// assert!(Proc::is_correct_type(&symbol.to_proc()), "not correct type!");
/// ```
///
/// Ruby:
///
/// ```ruby
/// sym = :hello
///
/// sym.to_s == 'hello'
/// ```
pub fn to_proc(&self) -> Proc {
Proc::from(unsafe { self.send("to_proc", &[]) }.value())
}
}
impl From<Value> for Symbol {
fn from(value: Value) -> Self {
Symbol { value: value }
}
}
impl Into<Value> for Symbol {
fn into(self) -> Value {
self.value
}
}
impl Into<AnyObject> for Symbol {
fn into(self) -> AnyObject {
AnyObject::from(self.value)
}
}
impl Object for Symbol {
#[inline]
fn value(&self) -> Value {
self.value
}
}
impl VerifiedObject for Symbol {
fn is_correct_type<T: Object>(object: &T) -> bool {
object.value().ty() == ValueType::Symbol
}
fn error_message() -> &'static str {
"Error converting to Symbol"
}
}
impl PartialEq for Symbol {
fn eq(&self, other: &Self) -> bool {
self.equals(other)
}
}
impl Eq for Symbol {}
impl Hash for Symbol {
fn hash<H>(&self, state: &mut H)
where
H: Hasher,
{
self.value().value.hash(state);
}
}