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 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
use std::{convert::From, default::Default};
use crate::{
binding::hash,
types::{Value, ValueType},
AnyObject, Object, VerifiedObject,
};
/// `Hash`
#[derive(Debug)]
#[repr(C)]
pub struct Hash {
value: Value,
}
impl Hash {
/// Creates a new instance of empty `Hash`.
///
/// # Examples
///
/// ```
/// use rutie::{Hash, VM};
/// # VM::init();
///
/// Hash::new();
/// ```
///
/// Ruby:
///
/// ```ruby
/// {}
/// ```
pub fn new() -> Self {
Self::from(hash::new())
}
/// Retrieves an `AnyObject` from element stored at `key` key.
///
/// # Examples
///
/// ```
/// use rutie::{Fixnum, Hash, Object, Symbol, VM};
/// # VM::init();
///
/// let mut hash = Hash::new();
///
/// hash.store(Symbol::new("key"), Fixnum::new(1));
///
/// assert_eq!(hash.at(&Symbol::new("key")).try_convert_to::<Fixnum>(), Ok(Fixnum::new(1)));
/// ```
///
/// Ruby:
///
/// ```ruby
/// hash = {}
/// hash[:key] = 1
///
/// hash[:key] == 1
/// ```
pub fn at<T: Object>(&self, key: &T) -> AnyObject {
let result = hash::aref(self.value(), key.value());
AnyObject::from(result)
}
/// Associates the `value` with the `key`.
///
/// Both `key` and `value` must be types which implement `Object` trait.
///
/// # Examples
///
/// ```
/// use rutie::{Fixnum, Hash, Object, Symbol, VM};
/// # VM::init();
///
/// let mut hash = Hash::new();
///
/// hash.store(Symbol::new("key"), Fixnum::new(1));
///
/// assert_eq!(hash.at(&Symbol::new("key")).try_convert_to::<Fixnum>(), Ok(Fixnum::new(1)));
/// ```
///
/// Ruby:
///
/// ```ruby
/// hash = {}
/// hash[:key] = 1
///
/// hash[:key] == 1
/// ```
pub fn store<K: Object, V: Object>(&mut self, key: K, value: V) -> AnyObject {
let result = hash::aset(self.value(), key.value(), value.value());
AnyObject::from(result)
}
/// Retrieves the length of the hash.
///
/// # Examples
///
/// ```
/// use rutie::{Hash, Fixnum, Symbol, VM};
/// # VM::init();
///
/// let mut hash = Hash::new();
///
/// hash.store(Symbol::new("key1"), Fixnum::new(1));
/// assert_eq!(hash.length(), 1);
///
/// hash.store(Symbol::new("key2"), Fixnum::new(2));
/// assert_eq!(hash.length(), 2);
/// ```
///
/// Ruby:
///
/// ```ruby
/// hash = {}
///
/// hash[:key1] = 1
/// hash.length == 1
///
/// hash[:key2] = 2
/// hash.length == 2
/// ```
pub fn length(&self) -> usize {
hash::length(self.value()) as usize
}
/// Removes all key-value pairs.
///
/// # Examples
///
/// ```
/// use rutie::{Hash, Fixnum, Symbol, VM};
/// # VM::init();
///
/// let mut hash = Hash::new();
///
/// hash.store(Symbol::new("key1"), Fixnum::new(1));
/// hash.store(Symbol::new("key2"), Fixnum::new(2));
/// assert_eq!(hash.length(), 2);
///
/// hash.clear();
/// assert_eq!(hash.length(), 0);
/// ```
///
/// Ruby:
///
/// ```ruby
/// hash = {}
///
/// hash[:key1] = 1
/// hash[:key2] = 2
/// hash.length == 2
///
/// hash.clear
///
/// hash.length == 0
/// ```
pub fn clear(&self) {
hash::clear(self.value())
}
/// Deletes the key-value pair and returns the value from hash whose key is equal to key. If
/// the key is not found, it returns nil.
///
/// `key` must be a type which implements the `Object` trait.
///
/// # Examples
///
/// ```
/// use rutie::{Fixnum, Hash, Object, Symbol, VM};
/// # VM::init();
///
/// let mut hash = Hash::new();
///
/// hash.store(Symbol::new("key1"), Fixnum::new(1));
/// hash.store(Symbol::new("key2"), Fixnum::new(2));
/// assert_eq!(hash.length(), 2);
///
/// let deleted = hash.delete(Symbol::new("key2"));
/// assert_eq!(hash.length(), 1);
/// assert_eq!(deleted.try_convert_to::<Fixnum>(), Ok(Fixnum::new(2)));
/// ```
///
/// Ruby:
///
/// ```ruby
/// hash = {}
///
/// hash[:key1] = 1
/// hash[:key2] = 2
/// hash.length == 2
///
/// deleted = hash.delete(:key2)
///
/// hash.length == 1
/// deleted == 2
/// ```
pub fn delete<K: Object>(&mut self, key: K) -> AnyObject {
let result = hash::delete(self.value(), key.value());
AnyObject::from(result)
}
/// Runs a closure for each `key` and `value` pair.
///
/// Key and value have `AnyObject` type.
///
/// # Examples
///
/// ```
/// use rutie::{Fixnum, Hash, Object, Symbol, VM};
/// # VM::init();
///
/// let mut hash = Hash::new();
///
/// hash.store(Symbol::new("first_key"), Fixnum::new(1));
/// hash.store(Symbol::new("second_key"), Fixnum::new(2));
///
/// let mut doubled_values: Vec<i64> = Vec::new();
///
/// hash.each(|_key, value| {
/// if let Ok(value) = value.try_convert_to::<Fixnum>() {
/// doubled_values.push(value.to_i64() * 2);
/// }
/// });
///
/// assert_eq!(doubled_values, vec![2, 4]);
/// ```
///
/// Ruby:
///
/// ```ruby
/// hash = {
/// first_key: 1,
/// second_key: 2
/// }
///
/// doubled_values = []
///
/// hash.each do |_key, value|
/// doubled_values << [value * 2]
/// end
///
/// doubled_values == [2, 4]
/// ```
pub fn each<F>(&self, closure: F)
where
F: FnMut(AnyObject, AnyObject),
{
hash::each(self.value(), closure);
}
}
impl Clone for Hash {
fn clone(&self) -> Hash {
Hash {
value: hash::dup(self.value()),
}
}
}
impl Default for Hash {
fn default() -> Self {
Hash::new()
}
}
impl From<Value> for Hash {
fn from(value: Value) -> Self {
Hash { value }
}
}
impl Into<Value> for Hash {
fn into(self) -> Value {
self.value
}
}
impl Into<AnyObject> for Hash {
fn into(self) -> AnyObject {
AnyObject::from(self.value)
}
}
impl Object for Hash {
#[inline]
fn value(&self) -> Value {
self.value
}
}
impl VerifiedObject for Hash {
fn is_correct_type<T: Object>(object: &T) -> bool {
object.value().ty() == ValueType::Hash
}
fn error_message() -> &'static str {
"Error converting to Hash"
}
}
impl PartialEq for Hash {
fn eq(&self, other: &Self) -> bool {
self.equals(other)
}
}
#[cfg(test)]
mod tests {
use super::super::super::{Fixnum, Hash, Object, Symbol, LOCK_FOR_TEST, VM};
#[test]
fn test_hash_each() {
let _guard = LOCK_FOR_TEST.write().unwrap();
VM::init();
let mut hash = Hash::new();
let len: i64 = 200;
for i in 0..len {
hash.store(Symbol::new(&format!("key_{}", i)), Fixnum::new(i));
}
assert_eq!(hash.length(), len as usize);
let mut counter: i64 = 0;
hash.each(|k, v| {
assert_eq!(
k.try_convert_to::<Symbol>().map(|s| s.to_string()),
Ok(format!("key_{}", counter))
);
assert_eq!(
v.try_convert_to::<Fixnum>().map(|f| f.to_i64()),
Ok(counter)
);
counter += 1;
});
assert_eq!(counter, len);
}
}