Binary format

[mikkelfj]

I did a very quick writeup of the FlatBuffers binary format. It is already document in Wouters FlatBuffers internals document, but in places there are implicit assumptions.

Also, the FlatCC verifier tool makes some hard rules that are not necessarily documented such that unions must only have a type field when the type is NONE.

In addition, Big Endian FlatBuffers and StreamBuffers are mentioned in passing.

This is a very rough document written in haste with lots of typos and lacking examples, but it wanted to get it down and refine on it later.

https://github.com/dvidelabs/flatcc/blob/master/doc/binary-format.md

StreamBuffers: https://github.com/dvidelabs/flatcc/blob/master/doc/binary-format.md#streambuffers

Wouters internals doc

https://google.github.io/flatbuffers/md__internals.html

[Wouter van Oortmerssen]

Wow, looks very thorough, though haven't had time to review it in detail. I should link to it from my doc, just in case people want a different perspective.

--
You received this message because you are subscribed to the Google Groups "FlatBuffers" group.
To unsubscribe from this group and stop receiving emails from it, send an email to flatbuffers+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[mikkelfj]

On Thursday, July 13, 2017 at 5:38:19 PM UTC+2, Wouter van Oortmerssen wrote:

Wow, looks very thorough, though haven't had time to review it in detail. I should link to it from my doc, just in case people want a different perspective.

 

thanks - yes I think it would be good to share - could help with interop - added an overview section, example buffer and example use of type hashes.

[agallego]

Thanks for the doc! that was a good read. 

[Wouter van Oortmerssen]

Added a link to this from my own format documentation:

https://github.com/google/flatbuffers/commit/8a2cc7cc4ebef69d455c6fe4e14399eb51033c5e

(note that it links to the first header rather than the whole document to circumvent a bug in doxygen that doesn't link correctly to external .md files).

--

[mikkelfj]

thanks

To unsubscribe from this group and stop receiving emails from it, send an email to flatbuffers...@googlegroups.com.