Struct rutie::Hash [−][src]
pub struct Hash { /* fields omitted */ }
Hash
Methods
impl Hash
[src]
impl Hash
pub fn new() -> Self
[src]
pub fn new() -> Self
pub fn at<T: Object>(&self, key: &T) -> AnyObject
[src]
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
pub fn store<K: Object, V: Object>(&mut self, key: K, value: V) -> AnyObject
[src]
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
pub fn length(&self) -> usize
[src]
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
pub fn clear(&self)
[src]
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
pub fn delete<K: Object>(&mut self, key: K) -> AnyObject
[src]
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
pub fn each<F>(&self, closure: F) where
F: FnMut(AnyObject, AnyObject),
[src]
pub fn each<F>(&self, closure: F) where
F: FnMut(AnyObject, AnyObject),
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
impl Debug for Hash
[src]
impl Debug for Hash
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl PartialEq for Hash
[src]
impl PartialEq for Hash
fn eq(&self, other: &Hash) -> bool
[src]
fn eq(&self, other: &Hash) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Hash) -> bool
[src]
fn ne(&self, other: &Hash) -> bool
This method tests for !=
.
impl Clone for Hash
[src]
impl Clone for Hash
fn clone(&self) -> Hash
[src]
fn clone(&self) -> Hash
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Default for Hash
[src]
impl Default for Hash
impl From<Value> for Hash
[src]
impl From<Value> for Hash
impl Object for Hash
[src]
impl Object for Hash
fn value(&self) -> Value
[src]
fn value(&self) -> Value
Returns internal value
of current object. Read more
fn class(&self) -> Class
[src]
fn class(&self) -> Class
Returns a class of current object. Read more
fn singleton_class(&self) -> Class
[src]
fn singleton_class(&self) -> Class
Returns a singleton class of current object. Read more
ⓘImportant traits for &'a mut Rfn get_data<'a, T>(&'a self, wrapper: &'a DataTypeWrapper<T>) -> &T
[src]
fn get_data<'a, T>(&'a self, wrapper: &'a DataTypeWrapper<T>) -> &T
Gets an immutable reference to the Rust structure which is wrapped into a Ruby object. Read more
ⓘImportant traits for &'a mut Rfn get_data_mut<'a, T>(&'a mut self, wrapper: &'a DataTypeWrapper<T>) -> &mut T
[src]
fn get_data_mut<'a, T>(&'a mut self, wrapper: &'a DataTypeWrapper<T>) -> &mut T
Gets a mutable reference to the Rust structure which is wrapped into a Ruby object.
ⓘImportant traits for &'a mut Rfn define<F: Fn(&mut Self)>(&mut self, f: F) -> &Self
[src]
fn define<F: Fn(&mut Self)>(&mut self, f: F) -> &Self
Wraps calls to the object. Read more
fn define_method<I: Object, O: Object>(
&mut self,
name: &str,
callback: Callback<I, O>
)
[src]
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
fn define_private_method<I: Object, O: Object>(
&mut self,
name: &str,
callback: Callback<I, O>
)
[src]
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
fn define_singleton_method<I: Object, O: Object>(
&mut self,
name: &str,
callback: Callback<I, O>
)
[src]
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
fn def<I: Object, O: Object>(&mut self, name: &str, callback: Callback<I, O>)
[src]
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>
)
[src]
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>
)
[src]
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
).
fn send(&self, method: &str, arguments: Option<&[AnyObject]>) -> AnyObject
[src]
fn send(&self, method: &str, arguments: Option<&[AnyObject]>) -> AnyObject
Calls a given method on an object similarly to Ruby Object#send
method Read more
fn equals<T: Object>(&self, other: &T) -> bool
[src]
fn equals<T: Object>(&self, other: &T) -> bool
Alias for Ruby's ==
Read more
fn case_equals<T: Object>(&self, other: &T) -> bool
[src]
fn case_equals<T: Object>(&self, other: &T) -> bool
Alias for Ruby's ===
Read more
fn is_eql<T: Object>(&self, other: &T) -> bool
[src]
fn is_eql<T: Object>(&self, other: &T) -> bool
Alias for Ruby's eql?
Read more
fn is_equal<T: Object>(&self, other: &T) -> bool
[src]
fn is_equal<T: Object>(&self, other: &T) -> bool
Alias for Ruby's equal?
Read more
fn respond_to(&self, method: &str) -> bool
[src]
fn respond_to(&self, method: &str) -> bool
Checks whether the object responds to given method Read more
fn protect_send(
&self,
method: String,
arguments: Option<&[AnyObject]>
) -> Result<AnyObject, AnyException>
[src]
fn protect_send(
&self,
method: String,
arguments: Option<&[AnyObject]>
) -> Result<AnyObject, AnyException>
protect_send
returns Result<AnyObject, AnyObject> Read more
fn protect_public_send(
&self,
method: String,
arguments: Option<&[AnyObject]>
) -> Result<AnyObject, AnyException>
[src]
fn protect_public_send(
&self,
method: String,
arguments: Option<&[AnyObject]>
) -> Result<AnyObject, AnyException>
protect_public_send
returns Result<AnyObject, AnyObject> Read more
fn is_nil(&self) -> bool
[src]
fn is_nil(&self) -> bool
Checks whether the object is nil
Read more
fn to_any_object(&self) -> AnyObject
[src]
fn to_any_object(&self) -> AnyObject
Converts struct to AnyObject
Read more
fn instance_variable_get(&self, variable: &str) -> AnyObject
[src]
fn instance_variable_get(&self, variable: &str) -> AnyObject
Gets an instance variable of object Read more
fn instance_variable_set<T: Object>(
&mut self,
variable: &str,
value: T
) -> AnyObject
[src]
fn instance_variable_set<T: Object>(
&mut self,
variable: &str,
value: T
) -> AnyObject
Sets an instance variable for object Read more
fn is_frozen(&self) -> bool
[src]
fn is_frozen(&self) -> bool
Returns the freeze status of the object. Read more
fn freeze(&mut self) -> Self
[src]
fn freeze(&mut self) -> Self
Prevents further modifications to the object. Read more
unsafe fn to<T: Object>(&self) -> T
[src]
unsafe fn to<T: Object>(&self) -> T
Unsafely casts current object to the specified Ruby type Read more
fn try_convert_to<T: VerifiedObject>(&self) -> Result<T, AnyException>
[src]
fn try_convert_to<T: VerifiedObject>(&self) -> Result<T, AnyException>
Safely casts current object to the specified Ruby type Read more
fn ty(&self) -> ValueType
[src]
fn ty(&self) -> ValueType
Determines the value type of the object Read more
impl VerifiedObject for Hash
[src]
impl VerifiedObject for Hash
fn is_correct_type<T: Object>(object: &T) -> bool
[src]
fn is_correct_type<T: Object>(object: &T) -> bool
fn error_message() -> &'static str
[src]
fn error_message() -> &'static str