Struct rosy::Hash

#[repr(transparent)]
pub struct Hash<K = AnyObject, V = AnyObject> { /* fields omitted */ }

An instance of Ruby's Hash class.

Methods

impl<K: Object, V: Object> Hash<K, V>

pub fn new() -> Self

Creates a new hash table.

pub fn from_map<'a, M, MK, MV>(map: M) -> Self where
    M: IntoIterator<Item = (&'a MK, &'a MV)>,
    MK: Copy + Into<K> + 'a,
    MV: Copy + Into<V> + 'a, 

Creates an instance from the key-value pairs in map.

Examples

This initializer is general enough to work with most map types. The most common use case would probably be interacting with Rust's HashMap.

use std::collections::HashMap;
use rosy::prelude::*;

let mut map = HashMap::new();
map.insert("is_working", true);

let hash = Hash::<String, AnyObject>::from_map(&map);
assert_eq!(hash.get("is_working").unwrap(), true);

pub fn from_pairs(pairs: &[(K, V)]) -> Self

This is supported on feature="ruby_2_6" only.

Creates a new hash table from pairs.

Examples

Although this may insert the objects efficiently, it requires a bit more verbose code with explicit Into conversions from non-Ruby types.

use rosy::{Hash, String};

let hash = Hash::<String, String>::from_pairs(&[
    ("user".into(), "nvzqz".into()),
    ("name".into(), "Nikolai Vazquez".into()),
]);

assert_eq!(hash.get("user").unwrap(), "nvzqz");
assert_eq!(hash.get("name").unwrap(), "Nikolai Vazquez");

pub unsafe fn insert(self, key: impl Into<K>, val: impl Into<V>)

Associates val with key.

Safety

The caller must ensure that self is not frozen or else a FrozenError exception will be raised.

Examples

Rust types can automagically be converted to keys and values:

use rosy::prelude::*;

let hash = Hash::<String, AnyObject>::new();
unsafe { hash.insert("should_eat", true) };

assert_eq!(hash.to_s(), r#"{"should_eat"=>true}"#);

pub unsafe fn insert_pairs(self, pairs: &[(K, V)])

This is supported on feature="ruby_2_6" only.

Inserts pairs into self in bulk.

Safety

The caller must ensure that self is not frozen or else a FrozenError exception will be raised.

pub fn get(self, key: impl Into<K>) -> Option<V>

Returns the value for key.

pub fn len(self) -> usize

Returns the number of key-value pairs in self.

pub fn is_empty(self) -> bool

Returns whether self is empty.

pub unsafe fn remove(self, key: impl Into<K>) -> Option<V>

Removes the value associated with key from self and returns it.

Safety

The caller must ensure that self is not frozen or else a FrozenError exception will be raised.

Examples

use rosy::prelude::*;

let hash = Hash::<String, AnyObject>::new();

unsafe {
    assert!(hash.remove("not_here").is_none());
    hash.insert("is_here", true);
    assert_eq!(hash.remove("is_here").unwrap(), true);
}

pub unsafe fn clear(self)

Removes all elements from self in-place.

Safety

The caller must ensure that self is not frozen or else a FrozenError exception will be raised.

Trait Implementations

impl GcInfoKey for Hash

fn stat_gc(self) -> Result<usize>

Returns the status information for self with respect to the garbage collector, or an exception if one is raised.

unsafe fn stat_gc_unchecked(self) -> usize

Returns the status information for self with respect to the garbage collector.

fn latest_gc_info(self) -> Result<AnyObject>

Returns the latest information regarding self with respect to the garbage collector.

unsafe fn latest_gc_info_unchecked(self) -> AnyObject

Returns the latest information regarding self with respect to the garbage collector.

impl<K: Object, V: Object> Object for Hash<K, V>

fn unique_id() -> Option<u128>

Returns a unique identifier for an object type to facilitate casting.

fn cast<A: Object>(obj: A) -> Option<Self>

Attempts to create an instance by casting obj.

fn ty(self) -> Ty

Returns the virtual type of self.

fn is_ty(self, ty: Ty) -> bool

Returns whether the virtual type of self is ty.

unsafe fn from_raw(raw: usize) -> Self

Creates a new object from raw without checking.

unsafe fn cast_unchecked(obj: impl Object) -> Self

Casts obj to Self without checking its type.

fn into_any_object(self) -> AnyObject

Returns self as an AnyObject.

fn as_any_object(&self) -> &AnyObject

Returns a reference to self as an AnyObject.

fn as_any_slice(&self) -> &[AnyObject]

Returns self as a reference to a single-element slice.

fn raw(self) -> usize

Returns the raw object pointer.

unsafe fn as_unchecked<O: Object>(&self) -> &O

Casts self to O without checking whether it is one.

unsafe fn into_unchecked<O: Object>(self) -> O

Converts self to O without checking whether it is one.

fn id(self) -> u64

Returns the object's identifier.

fn class(self) -> Class

Returns the Class for self.

fn singleton_class(self) -> Class

Returns the singleton Class of self, creating one if it doesn't exist already.

fn mark(self)

Marks self for Ruby to avoid garbage collecting it.

unsafe fn force_recycle(self)

Forces the garbage collector to free the contents of self.

fn def_singleton_method<N, F>(self, name: N, f: F) -> Result where
    N: Into<SymbolId>,
    F: MethodFn, 

Defines a method for name on the singleton class of self that calls f when invoked.

unsafe fn def_singleton_method_unchecked<N, F>(self, name: N, f: F) where
    N: Into<SymbolId>,
    F: MethodFn, 

Defines a method for name on the singleton class of self that calls f when invoked.

fn call(self, method: impl Into<SymbolId>) -> Result<AnyObject>

Calls method on self and returns the result.

unsafe fn call_unchecked(self, method: impl Into<SymbolId>) -> AnyObject

Calls method on self and returns the result.

fn call_with(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> Result<AnyObject>

Calls method on self with args and returns the result.

unsafe fn call_with_unchecked(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> AnyObject

Calls method on self with args and returns the result.

fn call_public(self, method: impl Into<SymbolId>) -> Result<AnyObject>

Calls the public method on self and returns the result.

unsafe fn call_public_unchecked(self, method: impl Into<SymbolId>) -> AnyObject

Calls the public method on self and returns the result.

fn call_public_with(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> Result<AnyObject>

Calls the public method on self with args and returns the result.

unsafe fn call_public_with_unchecked(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> AnyObject

Calls the public method on self with args and returns the result.

fn inspect(self) -> String

Returns a printable string representation of self.

fn to_s(self) -> String

Returns the result of calling the to_s method on self.

fn is_frozen(self) -> bool

Returns whether modifications can be made to self.

fn freeze(self)

Freezes self, preventing any further mutations.

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

Returns whether self is equal to other in terms of the eql? method.

impl<K: Object, V: Object> AsRef<AnyObject> for Hash<K, V>

fn as_ref(&self) -> &AnyObject

Performs the conversion.

impl<K, V> Clone for Hash<K, V>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K: Object, V: Object> From<Hash<K, V>> for AnyObject

fn from(object: Hash<K, V>) -> AnyObject

Performs the conversion.

impl<K: Object, V: Object, '_> From<&'_ [(K, V)]> for Hash<K, V>

fn from(pairs: &[(K, V)]) -> Self

Performs the conversion.

impl<K, V> Copy for Hash<K, V>

impl<K: Object, V: Object> PartialEq<AnyObject> for Hash<K, V>

fn eq(&self, obj: &AnyObject) -> 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<K: Object, V: Object> Debug for Hash<K, V>

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

Formats the value using the given formatter.

impl<K: Object, V: Object> Display for Hash<K, V>

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

Formats the value using the given formatter.

impl<K1, K2, V1, V2> FromIterator<(K2, V2)> for Hash<K1, V1> where
    K1: Object,
    K2: Into<K1>,
    V1: Object,
    V2: Into<V1>, 

fn from_iter<I: IntoIterator<Item = (K2, V2)>>(iter: I) -> Self

Creates a value from an iterator.