#[repr(C)]pub struct Hash { /* private fields */ }
Expand description
Hash
Implementations§
source§impl Hash
impl Hash
sourcepub fn at<T: Object>(&self, key: &T) -> AnyObject
pub fn at<T: Object>(&self, key: &T) -> AnyObject
Retrieves an AnyObject
from element stored at key
key.
Examples
use rutie::{Fixnum, Hash, Object, Symbol, VM};
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:
hash = {}
hash[:key] = 1
hash[:key] == 1
sourcepub fn store<K: Object, V: Object>(&mut self, key: K, value: V) -> AnyObject
pub fn store<K: Object, V: Object>(&mut self, key: K, value: V) -> AnyObject
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};
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:
hash = {}
hash[:key] = 1
hash[:key] == 1
sourcepub fn length(&self) -> usize
pub fn length(&self) -> usize
Retrieves the length of the hash.
Examples
use rutie::{Hash, Fixnum, Symbol, VM};
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:
hash = {}
hash[:key1] = 1
hash.length == 1
hash[:key2] = 2
hash.length == 2
sourcepub fn clear(&self)
pub fn clear(&self)
Removes all key-value pairs.
Examples
use rutie::{Hash, Fixnum, Symbol, VM};
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:
hash = {}
hash[:key1] = 1
hash[:key2] = 2
hash.length == 2
hash.clear
hash.length == 0
sourcepub fn delete<K: Object>(&mut self, key: K) -> AnyObject
pub fn delete<K: Object>(&mut self, key: K) -> AnyObject
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};
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:
hash = {}
hash[:key1] = 1
hash[:key2] = 2
hash.length == 2
deleted = hash.delete(:key2)
hash.length == 1
deleted == 2
sourcepub fn each<F>(&self, closure: F)
pub fn each<F>(&self, closure: F)
Runs a closure for each key
and value
pair.
Key and value have AnyObject
type.
Examples
use rutie::{Fixnum, Hash, Object, Symbol, VM};
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:
hash = {
first_key: 1,
second_key: 2
}
doubled_values = []
hash.each do |_key, value|
doubled_values << [value * 2]
end
doubled_values == [2, 4]
Trait Implementations§
source§impl Object for Hash
impl Object for Hash
source§fn singleton_class(&self) -> Class
fn singleton_class(&self) -> Class
Returns a singleton class of current object. Read more
source§fn get_data<'a, T>(&'a self, wrapper: &'a dyn DataTypeWrapper<T>) -> &T
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. Read more
source§fn get_data_mut<'a, T>(
&'a mut self,
wrapper: &'a dyn DataTypeWrapper<T>
) -> &mut T
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.
source§fn define_method<I: Object, O: Object>(
&mut self,
name: &str,
callback: Callback<I, O>
)
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. Read more
source§fn define_private_method<I: Object, O: Object>(
&mut self,
name: &str,
callback: Callback<I, O>
)
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. Read more
source§fn define_singleton_method<I: Object, O: Object>(
&mut self,
name: &str,
callback: Callback<I, O>
)
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. Read more
source§fn def<I: Object, O: Object>(&mut self, name: &str, callback: Callback<I, O>)
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
).source§fn def_private<I: Object, O: Object>(
&mut self,
name: &str,
callback: Callback<I, O>
)
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
).source§fn def_self<I: Object, O: Object>(
&mut self,
name: &str,
callback: Callback<I, O>
)
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
).source§unsafe fn send(&self, method: &str, arguments: &[AnyObject]) -> AnyObject
unsafe fn send(&self, method: &str, arguments: &[AnyObject]) -> AnyObject
Calls a given method on an object similarly to Ruby
Object#send
method Read moresource§fn respond_to(&self, method: &str) -> bool
fn respond_to(&self, method: &str) -> bool
Checks whether the object responds to given method Read more
source§fn protect_send(
&self,
method: &str,
arguments: &[AnyObject]
) -> Result<AnyObject, AnyException>
fn protect_send( &self, method: &str, arguments: &[AnyObject] ) -> Result<AnyObject, AnyException>
protect_send
returns Result<AnyObject, AnyObject> Read moresource§fn protect_public_send(
&self,
method: &str,
arguments: &[AnyObject]
) -> Result<AnyObject, AnyException>
fn protect_public_send( &self, method: &str, arguments: &[AnyObject] ) -> Result<AnyObject, AnyException>
protect_public_send
returns Result<AnyObject, AnyObject> Read moresource§fn to_any_object(&self) -> AnyObject
fn to_any_object(&self) -> AnyObject
Converts struct to
AnyObject
Read moresource§fn instance_variable_get(&self, variable: &str) -> AnyObject
fn instance_variable_get(&self, variable: &str) -> AnyObject
Gets an instance variable of object Read more
source§fn instance_variable_set<T: Object>(
&mut self,
variable: &str,
value: T
) -> AnyObject
fn instance_variable_set<T: Object>( &mut self, variable: &str, value: T ) -> AnyObject
Sets an instance variable for object Read more
source§unsafe fn to<T: Object>(&self) -> T
unsafe fn to<T: Object>(&self) -> T
Unsafely casts current object to the specified Ruby type Read more
source§fn try_convert_to<T: VerifiedObject>(&self) -> Result<T, AnyException>
fn try_convert_to<T: VerifiedObject>(&self) -> Result<T, AnyException>
Safely casts current object to the specified Ruby type Read more
source§impl PartialEq for Hash
impl PartialEq for Hash
source§impl VerifiedObject for Hash
impl VerifiedObject for Hash
fn is_correct_type<T: Object>(object: &T) -> bool
fn error_message() -> &'static str
Auto Trait Implementations§
impl RefUnwindSafe for Hash
impl Send for Hash
impl Sync for Hash
impl Unpin for Hash
impl UnwindSafe for Hash
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more