class Tkrzw::IndexIterator

Iterator for each record of the secondary index. An iterator is made by the “make_iterator” method of Index. Every unused iterator object should be destructed explicitly by the “destruct” method to free resources.

Public Class Methods

new(index) click to toggle source

Initializes the iterator.

@param index The index to scan.

# File tkrzw.rb, line 1343
def initialize(index)
  # (native code)
end

Public Instance Methods

destruct() click to toggle source

Releases the resource explicitly.

# File tkrzw.rb, line 1348
def destruct()
  # (native code)
end

first() click to toggle source

Initializes the iterator to indicate the first record.

# File tkrzw.rb, line 1353
def first()
  # (native code)
end

get() click to toggle source

Gets the key and the value of the current record of the iterator.

@return A tuple of the key and the value of the current record. On failure, nil is returned.

# File tkrzw.rb, line 1381
def get()
  # (native code)
end

inspect() click to toggle source

Returns a string representation of the object.

@return The string representation of the object.

# File tkrzw.rb, line 1393
def inspect()
  # (native code)
end

jump(key, value="") click to toggle source

Initializes the iterator to indicate a specific range.

@param key The key of the lower bound.
@param value The value of the lower bound.

# File tkrzw.rb, line 1365
def jump(key, value="")
  # (native code)
end

last() click to toggle source

Initializes the iterator to indicate the last record.

# File tkrzw.rb, line 1358
def last()
  # (native code)
end

next() click to toggle source

Moves the iterator to the next record.

# File tkrzw.rb, line 1370
def next()
  # (native code)
end

previous() click to toggle source

Moves the iterator to the previous record.

# File tkrzw.rb, line 1375
def previous()
  # (native code)
end

to_s() click to toggle source

Returns a string representation of the content.

@return The string representation of the content.

# File tkrzw.rb, line 1387
def to_s()
  # (native code)
end