Module: Ratomic::MapMethods

Defined in:

lib/ratomic/map.rb

Overview

Ruby convenience methods for Map.

Instance Method Summary

• #[](key) ⇒ Object^?

  Read a value by key.

• #[]=(key, value) ⇒ void

  Set a value for key.

• #empty? ⇒ Boolean

  Check whether the map currently has no entries.

• #length ⇒ Integer

  Alias for #size.

Instance Method Details

#[](key) ⇒ Object^?

Read a value by key.

Missing keys currently return nil, so storing nil is ambiguous.

Parameters:

• key (Object)

Returns:

• (Object, nil)

# File 'lib/ratomic/map.rb', line 36

def [](key)
  get(key)
end

#[]=(key, value) ⇒ void

This method returns an undefined value.

Set a value for key.

Parameters:

• key (Object)
• value (Object)

# File 'lib/ratomic/map.rb', line 26

def []=(key, value)
  set(key, value)
end

#empty? ⇒ Boolean

Check whether the map currently has no entries.

Returns:

• (Boolean)

# File 'lib/ratomic/map.rb', line 50

def empty?
  size.zero?
end

#length ⇒ Integer

Alias for #size.

Returns:

• (Integer)

# File 'lib/ratomic/map.rb', line 43

def length
  size
end