Class: Candid::Internal::CursorItemIterator

Inherits:

ItemIterator

• Object
• ItemIterator
• Candid::Internal::CursorItemIterator

Defined in:

lib/candid/internal/iterators/cursor_item_iterator.rb

Instance Method Summary

• #initialize(initial_cursor:, cursor_field:, item_field:, &block) ⇒ Candid::Internal::CursorItemIterator constructor

  Instantiates a CursorItemIterator, an Enumerable class which wraps calls to a cursor-based paginated API and yields individual items from it.

• #pages ⇒ Candid::Internal::CursorPageIterator

  Returns the CursorPageIterator mediating access to the underlying API.

Methods inherited from ItemIterator

#each, #get_next, #has_next?

Constructor Details

#initialize(initial_cursor:, cursor_field:, item_field:, &block) ⇒ Candid::Internal::CursorItemIterator

Instantiates a CursorItemIterator, an Enumerable class which wraps calls to a cursor-based paginated API and yields individual items from it.

Parameters:

• initial_cursor (String) —

  The initial cursor to use when iterating, if any.

• cursor_field (Symbol) —

  The field in API responses to extract the next cursor from.

• item_field (Symbol) —

  The field in API responses to extract the items to iterate over.

• block (Proc) —

  A block which is responsible for receiving a cursor to use and returning the given page from the API.

# File 'lib/candid/internal/iterators/cursor_item_iterator.rb', line 13

def initialize(initial_cursor:, cursor_field:, item_field:, &block)
  @item_field = item_field
  @page_iterator = CursorPageIterator.new(initial_cursor:, cursor_field:, &block)
  @page = nil
end

Instance Method Details

#pages ⇒ Candid::Internal::CursorPageIterator

Returns the CursorPageIterator mediating access to the underlying API.

Returns:

• (Candid::Internal::CursorPageIterator)

# File 'lib/candid/internal/iterators/cursor_item_iterator.rb', line 22

def pages
  @page_iterator
end