Class: ObjectSpace::WeakMap
Relationships & Source Files | |
Super Chains via Extension / Inclusion / Inheritance | |
Instance Chain:
self,
::Enumerable
|
|
Inherits: | Object |
Defined in: | gc.c, gc.c |
Overview
An WeakMap
object holds references to any objects, but those objects can get garbage collected.
This class is mostly used internally by WeakRef, please use lib/weakref.rb
for the public interface.
Instance Attribute Summary
::Enumerable - Included
Instance Method Summary
-
#[](wmap)
Retrieves a weakly referenced object with the given key.
-
#[]=(wmap, orig)
Creates a weak reference from the given key to the given value.
-
#each
(also: #each_pair)
Iterates over keys and objects in a weakly referenced object.
-
#each_key
Iterates over keys and objects in a weakly referenced object.
-
#each_pair
Alias for #each.
-
#each_value
Iterates over keys and objects in a weakly referenced object.
-
#include?(key) ⇒ Boolean
Alias for #key?.
- #inspect
-
#key?(key)
(also: #include?, #member?)
Returns
true
ifkey
is registered. -
#keys
Iterates over keys and objects in a weakly referenced object.
- #length (also: #size)
-
#member?(key) ⇒ Boolean
Alias for #key?.
-
#size
Alias for #length.
-
#values
Iterates over values and objects in a weakly referenced object.
- #finalize(objid) private
::Enumerable - Included
#chunk | Enumerates over the items, chunking them together based on the return value of the block. |
#chunk_while | Creates an enumerator for each chunked elements. |
#collect | Alias for Enumerable#map. |
#collect_concat | Alias for Enumerable#flat_map. |
#count | Returns the number of items in |
#cycle | Calls block for each element of enum repeatedly n times or forever if none or |
#detect | Alias for Enumerable#find. |
#drop | Drops first n elements from enum, and returns rest elements in an array. |
#drop_while | Drops elements up to, but not including, the first element for which the block returns |
#each_cons | Iterates the given block for each array of consecutive <n> elements. |
#each_entry | Calls block once for each element in |
#each_slice | Iterates the given block for each slice of <n> elements. |
#each_with_index | Calls block with two arguments, the item and its index, for each item in enum. |
#each_with_object | Iterates the given block for each element with an arbitrary object given, and returns the initially given object. |
#entries | Alias for Enumerable#to_a. |
#find | Passes each entry in enum to block. |
#find_all | Alias for Enumerable#select. |
#find_index | Compares each entry in enum with value or passes to block. |
#first | Returns the first element, or the first |
#flat_map | Returns a new array with the concatenated results of running block once for every element in enum. |
#grep | Returns an array of every element in enum for which |
#grep_v | Inverted version of Enumerable#grep. |
#group_by | Groups the collection by result of the block. |
#include? | Alias for Enumerable#member?. |
#inject | Combines all elements of enum by applying a binary operation, specified by a block or a symbol that names a method or operator. |
#lazy | Returns a lazy enumerator, whose methods map/collect, flat_map/collect_concat, select/find_all, reject, grep, grep_v, zip, take, take_while, drop, and drop_while enumerate values only on an as-needed basis. |
#map | Returns a new array with the results of running block once for every element in enum. |
#max | Returns the object in enum with the maximum value. |
#max_by | Returns the object in enum that gives the maximum value from the given block. |
#member? | Returns |
#min | Returns the object in enum with the minimum value. |
#min_by | Returns the object in enum that gives the minimum value from the given block. |
#minmax | Returns a two element array which contains the minimum and the maximum value in the enumerable. |
#minmax_by | Returns a two element array containing the objects in enum that correspond to the minimum and maximum values respectively from the given block. |
#partition | Returns two arrays, the first containing the elements of enum for which the block evaluates to true, the second containing the rest. |
#reduce | Alias for Enumerable#inject. |
#reject | Returns an array for all elements of |
#reverse_each | Builds a temporary array and traverses that array in reverse order. |
#select | Returns an array containing all elements of |
#slice_after | Creates an enumerator for each chunked elements. |
#slice_before | Creates an enumerator for each chunked elements. |
#slice_when | Creates an enumerator for each chunked elements. |
#sort | Returns an array containing the items in enum sorted, either according to their own |
#sort_by | Sorts enum using a set of keys generated by mapping the values in enum through the given block. |
#take | Returns first n elements from enum. |
#take_while | Passes elements to the block until the block returns |
#to_a | Returns an array containing the items in enum. |
#to_h | Returns the result of interpreting enum as a list of |
#zip | Takes one element from enum and merges corresponding elements from each args. |
Instance Method Details
#[](wmap)
Retrieves a weakly referenced object with the given key
#[]=(wmap, orig)
Creates a weak reference from the given key to the given value
#each Also known as: #each_pair
Iterates over keys and objects in a weakly referenced object
#each_key
Iterates over keys and objects in a weakly referenced object
#each_pair
Alias for #each.
#each_value
Iterates over keys and objects in a weakly referenced object
#finalize(objid) (private)
#include?(key) ⇒ Boolean
Alias for #key?.
#inspect
#key?(key) Also known as: #include?, #member?
Returns true
if key
is registered
#keys
Iterates over keys and objects in a weakly referenced object
#length Also known as: #size
#member?(key) ⇒ Boolean
Alias for #key?.
#size
Alias for #length.
#values
Iterates over values and objects in a weakly referenced object