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

Class: Mongo::Protocol::CachingHashPrivate

Inherits:

Object

• Object
• Mongo::Protocol::CachingHash show all

Defined in:

lib/mongo/protocol/caching_hash.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.

A Hash that caches the results of #to_bson.

Instance Method Summarycollapse

• #bson_type ⇒ Object private
• #initialize(hash) ⇒ CachingHash constructor private
  A new instance of CachingHash.
• #to_bson(buffer = BSON::ByteBuffer.new, validating_keys = nil) ⇒ BSON::ByteBuffer private
  Caches the result of to_bson and writes it to the given buffer on subsequent calls to this method.

Constructor Details

#initialize(hash) ⇒ CachingHash

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 CachingHash.

Instance Method Details

#bson_type ⇒ 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.

#to_bson(buffer = BSON::ByteBuffer.new, validating_keys = nil) ⇒ BSON::ByteBuffer

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.

Caches the result of to_bson and writes it to the given buffer on subsequent calls to this method. If this method is originally called without validation, and then is subsequently called with validation, we will want to recalculate the to_bson to trigger the validations.