RUBY-2264 add note documenting the behavior of the buffer in an error…

… condition (#312)
mongodb · Jul 5, 2023 · c8a20b4 · c8a20b4
1 parent 9484d2a
commit c8a20b4
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 0 deletions.
diff --git a/lib/bson/array.rb b/lib/bson/array.rb
@@ -110,6 +110,11 @@ module ClassMethods
 
       # Deserialize the array from BSON.
       #
+      # @note If the argument cannot be parsed, an exception will be raised
+      #   and the argument will be left in an undefined state. The caller
+      #   must explicitly call `rewind` on the buffer before trying to parse
+      #   it again.
+      #
       # @param [ ByteBuffer ] buffer The byte buffer.
       #
       # @option options [ nil | :bson ] :mode Decoding mode to use.

diff --git a/lib/bson/hash.rb b/lib/bson/hash.rb
@@ -97,6 +97,11 @@ module ClassMethods
 
       # Deserialize the hash from BSON.
       #
+      # @note If the argument cannot be parsed, an exception will be raised
+      #   and the argument will be left in an undefined state. The caller
+      #   must explicitly call `rewind` on the buffer before trying to parse
+      #   it again.
+      #
       # @param [ ByteBuffer ] buffer The byte buffer.
       #
       # @option options [ nil | :bson ] :mode Decoding mode to use.

diff --git a/lib/bson/regexp.rb b/lib/bson/regexp.rb
@@ -271,6 +271,11 @@ module ClassMethods
 
       # Deserialize the regular expression from BSON.
       #
+      # @note If the argument cannot be parsed, an exception will be raised
+      #   and the argument will be left in an undefined state. The caller
+      #   must explicitly call `rewind` on the buffer before trying to parse
+      #   it again.
+      #
       # @param [ ByteBuffer ] buffer The byte buffer.
       #
       # @option opts [ nil | :bson ] :mode Decoding mode to use.