KillSpec — Documentation by YARD 0.9.37 (original) (raw)
Class: Mongo::Cursor::KillSpecPrivate
Inherits:
Object
- Object
- Mongo::Cursor::KillSpec show all
Defined in:
lib/mongo/cursor/kill_spec.rb
Overview
This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.
This class contains the operation specification for KillCursors.
Its purpose is to ensure we don’t misspell attribute names accidentally.
Instance Attribute Summary collapse
- #coll_name ⇒ Object readonly private
- #connection ⇒ Object readonly private
- #connection_global_id ⇒ Object readonly private
- #cursor_id ⇒ Object readonly private
- #db_name ⇒ Object readonly private
- #server_address ⇒ Object readonly private
- #session ⇒ Object readonly private
Instance Method Summarycollapse
- #==(other) ⇒ Object private
- #eql?(other) ⇒ Boolean private
- #hash ⇒ Object private
- #initialize(cursor_id:, coll_name:, db_name:, connection_global_id:, server_address:, session:, connection: nil) ⇒ KillSpec constructor private
A new instance of KillSpec.
Constructor Details
#initialize(cursor_id:, coll_name:, db_name:, connection_global_id:, server_address:, session:, connection: nil) ⇒ KillSpec
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.
Returns a new instance of KillSpec.
| 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 | # File 'lib/mongo/cursor/kill_spec.rb', line 28 def initialize( cursor_id:, coll_name:, db_name:, connection_global_id:, server_address:, session:, connection: nil ) @cursor_id = cursor_id @coll_name = coll_name @db_name = db_name @connection_global_id = connection_global_id @server_address = server_address @session = session @connection = connection end |
|---|
Instance Attribute Details
#coll_name ⇒ Object
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.
| 46 47 48 | # File 'lib/mongo/cursor/kill_spec.rb', line 46 def coll_name @coll_name end |
|---|
#connection ⇒ Object
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.
| 46 47 48 | # File 'lib/mongo/cursor/kill_spec.rb', line 46 def connection @connection end |
|---|
#connection_global_id ⇒ Object
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.
| 46 47 48 | # File 'lib/mongo/cursor/kill_spec.rb', line 46 def connection_global_id @connection_global_id end |
|---|
#cursor_id ⇒ Object
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.
| 46 47 48 | # File 'lib/mongo/cursor/kill_spec.rb', line 46 def cursor_id @cursor_id end |
|---|
#db_name ⇒ Object
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.
| 46 47 48 | # File 'lib/mongo/cursor/kill_spec.rb', line 46 def db_name @db_name end |
|---|
#server_address ⇒ Object
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.
| 46 47 48 | # File 'lib/mongo/cursor/kill_spec.rb', line 46 def server_address @server_address end |
|---|
#session ⇒ Object
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.
| 46 47 48 | # File 'lib/mongo/cursor/kill_spec.rb', line 46 def session @session end |
|---|
Instance Method Details
#==(other) ⇒ Object
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.
| 54 55 56 57 58 59 60 61 | # File 'lib/mongo/cursor/kill_spec.rb', line 54 def ==(other) cursor_id == other.cursor_id && coll_name == other.coll_name && db_name == other.db_name && connection_global_id == other.connection_global_id && server_address == other.server_address && session == other.session end |
|---|
#eql?(other) ⇒ Boolean
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.
| 63 64 65 | # File 'lib/mongo/cursor/kill_spec.rb', line 63 def eql?(other) self.==(other) end |
|---|
#hash ⇒ Object
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.
| 67 68 69 70 71 72 73 74 75 76 | # File 'lib/mongo/cursor/kill_spec.rb', line 67 def hash [ cursor_id, coll_name, db_name, connection_global_id, server_address, session, ].compact.hash end |
|---|