diff --git a/docs/source/Tutorial.md b/docs/source/Tutorial.md index 100191d7a..c71a9fad1 100644 --- a/docs/source/Tutorial.md +++ b/docs/source/Tutorial.md @@ -1161,12 +1161,23 @@ like so: ~~~{.java} // This must be called after `finish()`. java.nio.ByteBuffer buf = builder.dataBuffer(); + // The data in this ByteBuffer does NOT start at 0, but at buf.position(). + // The number of bytes is buf.remaining(). + + // Alternatively this copies the above data out of the ByteBuffer for you: + bytes[] buf = builder.sizedByteArray(); ~~~
~~~{.cs} // This must be called after `Finish()`. var buf = builder.DataBuffer; // Of type `FlatBuffers.ByteBuffer`. + // The data in this ByteBuffer does NOT start at 0, but at buf.Position. + // The end of the data is marked by buf.Length, so the size is + // buf.Length - buf.Position. + + // Alternatively this copies the above data out of the ByteBuffer for you: + bytes[] buf = builder.SizedByteArray(); ~~~
@@ -1184,13 +1195,16 @@ like so:
~~~{.js} // This must be called after `finish()`. - var buf = builder.dataBuffer(); // Of type `flatbuffers.ByteBuffer`. + var buf = builder.asUint8Array(); // Of type `Uint8Array`. ~~~
~~~{.php} // This must be called after `finish()`. $buf = $builder->dataBuffer(); // Of type `Google\FlatBuffers\ByteBuffer` + // The data in this ByteBuffer does NOT start at 0, but at buf->getPosition(). + // The end of the data is marked by buf->capacity(), so the size is + // buf->capacity() - buf->getPosition(). ~~~
diff --git a/js/flatbuffers.js b/js/flatbuffers.js index 511c9a216..69bb783e9 100644 --- a/js/flatbuffers.js +++ b/js/flatbuffers.js @@ -238,9 +238,8 @@ flatbuffers.Builder.prototype.dataBuffer = function() { }; /** - * Get the ByteBuffer representing the FlatBuffer. Only call this after you've - * called finish(). The actual data starts at the ByteBuffer's current position, - * not necessarily at 0. + * Get the bytes representing the FlatBuffer. Only call this after you've + * called finish(). * * @returns {Uint8Array} */ diff --git a/net/FlatBuffers/FlatBufferBuilder.cs b/net/FlatBuffers/FlatBufferBuilder.cs index 590e6ac0d..8c57abec1 100644 --- a/net/FlatBuffers/FlatBufferBuilder.cs +++ b/net/FlatBuffers/FlatBufferBuilder.cs @@ -582,6 +582,8 @@ namespace FlatBuffers /// /// /// This is typically only called after you call `Finish()`. + /// The actual data starts at the ByteBuffer's current position, + /// not necessarily at `0`. /// /// /// Returns the ByteBuffer for this FlatBuffer.