Wref
Weak references for Ruby
Install
Add to your Gemfile and bundle
gem "wref"Usage
Make a new weak reference
str = "Test"
weak_ref = Wref.new(str)Check if reference is still alive
weak_ref.alive? #=> true | falseSpawn a weak map
weak_map = Wref::Map.newSet a key and value in a weak map
str = "Test"
map[1] = str
map.set(1, str)Get values from a weak map
map.get(1) #=> "Test" | nil
map.get!(1) #=> "Test" | Wref::Recycled errorLoop over all valid pairs in a weak map
map.each do |key, value|
puts "Valid pair: #{key}: #{value}"
endCheck if key is valid in a weak map.
map.valid?(1) #=> true | falseGetting length of both valid and invalid and the current time in a weak map (fastest)
map.length #=> 1Getting length of valid options in a weak map
map.length_valid #=> 0Get from a key
map.get(1) #=> "Test" | nil
map.get!(1) #=> "Test" | Error - Wref::RecycledDelete a key from a weak map
map.delete(1) #=> "Test" | nil if recycledDelete all recycled options
map.cleanContributing to wref
- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
- Fork the project.
- Start a feature/bugfix branch.
- Commit and push until you are happy with your contribution.
- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
Copyright
Copyright (c) 2012 Kasper Johansen. See LICENSE.txt for further details.