Generates constructors and accessors for all data types declared in the given flatbuffers schema whose namespace matches the current module.

namespace Data.Game;

table Monster {}

{-# LANGUAGE TemplateHaskell #-}

module Data.Game where

import FlatBuffers

$(mkFlatBuffers "schemas/game.fbs" defaultOptions)

Default flatbuffers options:

Options
  { includeDirectories = []
  , compileAllSchemas = False
  }

Options to control how/which flatbuffers constructors/accessor should be generated.

Options can be set using record syntax on defaultOptions with the fields below.

defaultOptions { compileAllSchemas = True }

Serializes a flatbuffer table as a lazy ByteString.

Serializes a flatbuffer table as a lazy ByteString and adds a File Identifier.

Constructs a missing union table field / vector element.

Deserializes a flatbuffer from a lazy ByteString.

Checks if a buffer contains the file identifier for a root table a, to see if it's safe to decode it to a Table. It should be used in conjunction with -XTypeApplications.

{-# LANGUAGE TypeApplications #-}

if checkFileIdentifier @Monster bs
  then decode @Monster bs
  else return someMonster

An identifier that's used to "mark" a buffer. To add this marker to a buffer, use encodeWithFileIdentifier. To check whether a buffer contains the marker before decoding it, use checkFileIdentifier.

For more information on file identifiers, see :

• The library's docs
• Section "File identification and extension" of the official docs

Associates a type with a file identifier. To create an association, declare a root_type and file_identifier in your schema.

table Player {}
root_type Player;
file_identifier "PLYR";

A struct to be written to a flatbuffer.

A table to be written to a flatbuffer.

A union to be written to a flatbuffer.

A struct that is being read from a flatbuffer.

A table that is being read from a flatbuffer.

A union that is being read from a flatbuffer.

The number of bytes occupied by a piece of data that's stored "inline"

"inline" here means "stored directly in a table or a vector, and not by reference". E.g.: numeric types, booleans, structs, offsets.

The memory alignment (in bytes) for a piece of data in a flatbuffer. E.g., Int32 are always aligned to 4 bytes. This number should always be a power of 2 in the range [1, 16].

Metadata for a struct type.