NonTailable — Documentation by YARD 0.9.37 (original) (raw)

Module: Mongo::Cursor::NonTailablePrivate

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

This module is used by cursor-implementing classes to indicate that the only cursors they generate are non-tailable, and iterable.

Instance Method Summarycollapse

• #cursor_type ⇒ nil private
  These views are always non-tailable.
• #timeout_mode ⇒ :iterable private
  These views apply timeouts to each iteration of a cursor, as opposed to the entire lifetime of the cursor.

Instance Method Details

#cursor_type ⇒ nil

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

These views are always non-tailable.

#timeout_mode ⇒ :iterable

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

These views apply timeouts to each iteration of a cursor, as opposed to the entire lifetime of the cursor.