Initialize a new result.

@example Instantiate the result.

  Result.new(replies)

@param [ Protocol::Reply ] replies The wire protocol replies.

@since 2.0.0

Is the result acknowledged?

@note On MongoDB 2.6 and higher all writes are acknowledged since the

  driver uses write commands for all write operations. On 2.4 and
  lower, the result is acknowledged if the GLE has been executed after
  the command. If not, no replies will be specified. Reads will always
  return true here since a replies is always provided.

@return [ true, false ] If the result is acknowledged.

@since 2.0.0

Get the cluster time reported in the server response.

@example Get the cluster time.

  result.cluster_time

@return [ BSON::Document ] The cluster time document.

@since 2.5.0

Get the cursor id if the response is acknowledged.

@note Cursor ids of 0 indicate there is no cursor on the server.

@example Get the cursor id.

  result.cursor_id

@return [ Integer ] The cursor id.

@since 2.0.0

Get the documents in the result.

@example Get the documents.

  result.documents

@return [ Array<BSON::Document> ] The documents.

@since 2.0.0

Iterate over the documents in the replies.

@example Iterate over the documents.

  result.each do |doc|
    p doc
  end

@return [ Enumerator ] The enumerator.

@since 2.0.0

@yieldparam [ BSON::Document ] Each document in the result.

Get the pretty formatted inspection of the result.

@example Inspect the result.

  result.inspect

@return [ String ] The inspection.

@since 2.0.0

Gets the set of error labels associated with the result.

@example Get the labels.

  result.labels

@return [ Array ] labels The set of labels.

@since 2.7.0

Determine if this result is a collection of multiple replies from the server.

@example Is the result for multiple replies?

  result.multiple?

@return [ true, false ] If the result is for multiple replies.

@since 2.0.0

Alias for written_count

Get the namespace of the cursor. The method should be defined in result classes where ‘ns’ is in the server response.

@return [ Nil ]

@since 2.0.0

Check the first document‘s ok field.

@example Check the ok field.

  result.ok?

@return [ true, false ] If the command returned ok.

@since 2.1.0

Get the operation time reported in the server response.

@example Get the operation time.

  result.operation_time

@return [ Object ] The operation time value.

@since 2.5.0

Get the first reply from the result.

@example Get the first reply.

  result.reply

@return [ Protocol::Reply ] The first reply.

@since 2.0.0

Get the count of documents returned by the server.

@example Get the number returned.

  result.returned_count

@return [ Integer ] The number of documents returned.

@since 2.0.0

If the result was a command then determine if it was considered a success.

@note If the write was unacknowledged, then this will always return

  true.

@example Was the command successful?

  result.successful?

@return [ true, false ] If the command was successful.

@since 2.0.0

Validate the result by checking for any errors.

@note This only checks for errors with writes since authentication is

  handled at the connection level and any authentication errors would
  be raised there, before a Result is ever created.

@example Validate the result.

  result.validate!

@raise [ Error::OperationFailure ] If an error is in the result.

@return [ Result ] The result if verification passed.

@since 2.0.0

Get the number of documents written by the server.

@example Get the number of documents written.

  result.written_count

@return [ Integer ] The number of documents written.

@since 2.0.0