Class: Prosody::PublishedMap

Inherits:

Object

• Object
• Prosody::PublishedMap

Includes:

State::Scanning

Defined in:

lib/prosody/state.rb,
sig/state.rbs

Instance Method Summary

• #each_key(key) {|arg0| ... } ⇒ Object
• #each_pair(key) {|arg0, arg1| ... } ⇒ Object (also: #each)
• #each_value(key) {|arg0| ... } ⇒ Object
• #get(key, map_key) ⇒ V^?
• #get_many(key, map_keys) ⇒ Array[V?]
• #initialize(native) ⇒ PublishedMap constructor

  A new instance of PublishedMap.

• #key?(key, map_key) ⇒ Boolean (also: #has_key?, #include?, #member?)
• #reverse_each_key(key) {|arg0| ... } ⇒ Object
• #reverse_each_pair(key) {|arg0, arg1| ... } ⇒ Object
• #reverse_each_value(key) {|arg0| ... } ⇒ Object

Methods included from State::Scanning

#scan_each, #scan_items

Constructor Details

#initialize(native) ⇒ PublishedMap

Returns a new instance of PublishedMap.

# File 'lib/prosody/state.rb', line 246

def initialize(native) = @native = native

Instance Method Details

#each_key(key) ⇒ void #each_key(key) ⇒ Enumerator[String, void]

Overloads:

• #each_key(key) ⇒ void

  This method returns an undefined value.

  Parameters:

  • key (_ToS)
• #each_key(key) ⇒ Enumerator[String, void]

  Parameters:

  • key (_ToS)

  Returns:

  • (Enumerator[String, void])

Yields:

Yield Parameters:

• arg0 (String)

Yield Returns:

• (void)

# File 'lib/prosody/state.rb', line 256

def each_key(key, &block) = traverse_keys(key, :forward, &block)

#each_pair(key) ⇒ void #each_pair(key) ⇒ Enumerator[[String, V], void] Also known as: each

Overloads:

• #each_pair(key) ⇒ void

  This method returns an undefined value.

  Parameters:

  • key (_ToS)
• #each_pair(key) ⇒ Enumerator[[String, V], void]

  Parameters:

  • key (_ToS)

  Returns:

  • (Enumerator[[String, V], void])

Yields:

Yield Parameters:

• arg0 (String)
• arg1 (V)

Yield Returns:

• (void)

# File 'lib/prosody/state.rb', line 254

def each_pair(key, &block) = traverse(key, :forward, &block)

#each_value(key) ⇒ void #each_value(key) ⇒ Enumerator[V, void]

Overloads:

• #each_value(key) ⇒ void

  This method returns an undefined value.

  Parameters:

  • key (_ToS)
• #each_value(key) ⇒ Enumerator[V, void]

  Parameters:

  • key (_ToS)

  Returns:

  • (Enumerator[V, void])

Yields:

Yield Parameters:

• arg0 (V)

Yield Returns:

• (void)

# File 'lib/prosody/state.rb', line 258

def each_value(key, &block) = traverse_values(key, :forward, &block)

#get(key, map_key) ⇒ V^?

Parameters:

• key (_ToS)
• map_key (_ToS)

Returns:

• (V, nil)

# File 'lib/prosody/state.rb', line 247

def get(key, map_key) = @native.get(key.to_s, map_key.to_s)

#get_many(key, map_keys) ⇒ Array[V?]

Parameters:

• key (_ToS)
• map_keys (Array[_ToS])

Returns:

• (Array[V?])

# File 'lib/prosody/state.rb', line 248

def get_many(key, map_keys) = @native.get_many(key.to_s, map_keys.map(&:to_s))

#key?(key, map_key) ⇒ Boolean Also known as: has_key?, include?, member?

Parameters:

• key (_ToS)
• map_key (_ToS)

Returns:

• (Boolean)

# File 'lib/prosody/state.rb', line 249

def key?(key, map_key) = @native.contains_key(key.to_s, map_key.to_s)

#reverse_each_key(key) ⇒ void #reverse_each_key(key) ⇒ Enumerator[String, void]

Overloads:

• #reverse_each_key(key) ⇒ void

  This method returns an undefined value.

  Parameters:

  • key (_ToS)
• #reverse_each_key(key) ⇒ Enumerator[String, void]

  Parameters:

  • key (_ToS)

  Returns:

  • (Enumerator[String, void])

Yields:

Yield Parameters:

• arg0 (String)

Yield Returns:

• (void)

# File 'lib/prosody/state.rb', line 257

def reverse_each_key(key, &block) = traverse_keys(key, :backward, &block)

#reverse_each_pair(key) ⇒ void #reverse_each_pair(key) ⇒ Enumerator[[String, V], void]

Overloads:

• #reverse_each_pair(key) ⇒ void

  This method returns an undefined value.

  Parameters:

  • key (_ToS)
• #reverse_each_pair(key) ⇒ Enumerator[[String, V], void]

  Parameters:

  • key (_ToS)

  Returns:

  • (Enumerator[[String, V], void])

Yields:

Yield Parameters:

• arg0 (String)
• arg1 (V)

Yield Returns:

• (void)

# File 'lib/prosody/state.rb', line 255

def reverse_each_pair(key, &block) = traverse(key, :backward, &block)

#reverse_each_value(key) ⇒ void #reverse_each_value(key) ⇒ Enumerator[V, void]

Overloads:

• #reverse_each_value(key) ⇒ void

  This method returns an undefined value.

  Parameters:

  • key (_ToS)
• #reverse_each_value(key) ⇒ Enumerator[V, void]

  Parameters:

  • key (_ToS)

  Returns:

  • (Enumerator[V, void])

Yields:

Yield Parameters:

• arg0 (V)

Yield Returns:

• (void)

# File 'lib/prosody/state.rb', line 259

def reverse_each_value(key, &block) = traverse_values(key, :backward, &block)