File: nontailable.rb

package info (click to toggle)
ruby-mongo 2.21.3-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 14,764 kB
  • sloc: ruby: 108,806; makefile: 5; sh: 2
file content (27 lines) | stat: -rw-r--r-- 701 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
# frozen_string_literal: true

module Mongo
  class Cursor
    # This module is used by cursor-implementing classes to indicate that
    # the only cursors they generate are non-tailable, and iterable.
    #
    # @api private
    module NonTailable
      # These views are always non-tailable.
      #
      # @return [ nil ] indicating a non-tailable cursor.
      def cursor_type
        nil
      end

      # These views apply timeouts to each iteration of a cursor, as
      # opposed to the entire lifetime of the cursor.
      #
      # @return [ :iterable ] indicating a cursor with a timeout mode of
      #   "iterable".
      def timeout_mode
        :iterable
      end
    end
  end
end