@@ -127,9 +127,13 @@ class Serialize a where
127127 -- offset but that may require traversing the Haskell structure again to get
128128 -- the size. Therefore, this is a performance optimization.
129129
130− -- | @deserializeAt byte-offset array arrayLen@ deserializes a value from the
131− -- given byte-offset in the array. Returns a tuple consisting of the next
132− -- byte-offset and the deserialized value.
130+ -- | @deserializeAt byte-offset array arrayLen@ deserializes a value from
131+ -- the given byte-offset in the array. Returns a tuple consisting of the
132+ -- next byte-offset and the deserialized value.
133+ --
134+ -- The arrayLen passed is the entire length of the input buffer. It is to
135+ -- be used to check if we would overflow the input buffer when
136+ -- deserializing.
133137 --
134138 -- Throws an exception if the operation would exceed the supplied arrayLen.
135139 deserializeAt :: Int -> MutByteArray -> Int -> IO (Int, a)