FlatBuffers

TemplateHaskell

mkFlatBuffers :: FilePath -> Options -> Q [Dec]

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)

defaultOptions :: Options

Default flatbuffers options:

Options
  { includeDirectories = []
  , compileAllSchemas = False
  }

data Options

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 }

Constructors

Options

Fields

• includeDirectories :: [FilePath]

  Directories to search for includes (same as flatc -I option).

• compileAllSchemas :: Bool

  Generate code not just for the root schema, but for all schemas it includes as well (same as flatc --gen-all option).

Instances

Eq Options

Defined in FlatBuffers.Internal.Compiler.TH

Methods

(==) :: Options -> Options -> Bool

(/=) :: Options -> Options -> Bool

Show Options

Defined in FlatBuffers.Internal.Compiler.TH

Methods

showsPrec :: Int -> Options -> ShowS

show :: Options -> String

showList :: [Options] -> ShowS

Creating a flatbuffer

encode :: WriteTable a -> ByteString

Serializes a flatbuffer table as a lazy ByteString.

encodeWithFileIdentifier :: forall a. HasFileIdentifier a => WriteTable a -> ByteString

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

none :: WriteUnion a

Constructs a missing union table field / vector element.

Reading a flatbuffer

decode :: ByteString -> Either ReadError (Table a)

Deserializes a flatbuffer from a lazy ByteString.

checkFileIdentifier :: forall a. HasFileIdentifier a => ByteString -> Bool

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

File Identifier

data FileIdentifier

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

Instances

Eq FileIdentifier

Defined in FlatBuffers.Internal.FileIdentifier

Methods

(==) :: FileIdentifier -> FileIdentifier -> Bool

(/=) :: FileIdentifier -> FileIdentifier -> Bool

Show FileIdentifier

Defined in FlatBuffers.Internal.FileIdentifier

Methods

showsPrec :: Int -> FileIdentifier -> ShowS

show :: FileIdentifier -> String

showList :: [FileIdentifier] -> ShowS

class HasFileIdentifier a where

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";

Methods

getFileIdentifier :: FileIdentifier

Types

data WriteStruct a

A struct to be written to a flatbuffer.

Instances

IsStruct a => WriteVectorElement (WriteStruct a)

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector (WriteStruct a) :: Type

Methods

fromMonoFoldable :: (MonoFoldable mono, Element mono ~ WriteStruct a) => Int32 -> mono -> WriteVector (WriteStruct a)

newtype WriteVector (WriteStruct a)

Defined in FlatBuffers.Internal.Write

newtype WriteVector (WriteStruct a) = WriteVectorStruct {

• writeVectorStructTableField :: WriteTableField

}

data WriteTable a

A table to be written to a flatbuffer.

Instances

WriteVectorElement (WriteTable a)

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector (WriteTable a) :: Type

Methods

fromMonoFoldable :: (MonoFoldable mono, Element mono ~ WriteTable a) => Int32 -> mono -> WriteVector (WriteTable a)

newtype WriteVector (WriteTable a)

Defined in FlatBuffers.Internal.Write

newtype WriteVector (WriteTable a) = WriteVectorTable {

• writeVectorTableTableField :: WriteTableField

}

data WriteUnion a

A union to be written to a flatbuffer.

Instances

WriteVectorElement (WriteUnion a)

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector (WriteUnion a) :: Type

Methods

fromMonoFoldable :: (MonoFoldable mono, Element mono ~ WriteUnion a) => Int32 -> mono -> WriteVector (WriteUnion a)

data WriteVector (WriteUnion a)

Defined in FlatBuffers.Internal.Write

data WriteVector (WriteUnion a) = WriteVectorUnion !WriteTableField !WriteTableField

data Struct a

A struct that is being read from a flatbuffer.

Instances

IsStruct a => VectorElement (Struct a)

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector (Struct a) :: Type

Methods

length :: Vector (Struct a) -> Int32

unsafeIndex :: Vector (Struct a) -> Int32 -> Either ReadError (Struct a)

toList :: Vector (Struct a) -> Either ReadError [Struct a]

take :: Int32 -> Vector (Struct a) -> Vector (Struct a)

drop :: Int32 -> Vector (Struct a) -> Vector (Struct a)

data Vector (Struct a)

Defined in FlatBuffers.Internal.Read

data Vector (Struct a) = VectorStruct !Int32 !Position

data Table a

A table that is being read from a flatbuffer.

Instances

VectorElement (Table a)

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector (Table a) :: Type

Methods

length :: Vector (Table a) -> Int32

unsafeIndex :: Vector (Table a) -> Int32 -> Either ReadError (Table a)

toList :: Vector (Table a) -> Either ReadError [Table a]

take :: Int32 -> Vector (Table a) -> Vector (Table a)

drop :: Int32 -> Vector (Table a) -> Vector (Table a)

data Vector (Table a)

Defined in FlatBuffers.Internal.Read

data Vector (Table a) = VectorTable !Int32 !PositionInfo

data Union a

A union that is being read from a flatbuffer.

Constructors

Union !a

UnionNone

UnionUnknown !Word8

Instances

VectorElement (Union a)

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector (Union a) :: Type

Methods

length :: Vector (Union a) -> Int32

unsafeIndex :: Vector (Union a) -> Int32 -> Either ReadError (Union a)

toList :: Vector (Union a) -> Either ReadError [Union a]

take :: Int32 -> Vector (Union a) -> Vector (Union a)

drop :: Int32 -> Vector (Union a) -> Vector (Union a)

data Vector (Union a)

Defined in FlatBuffers.Internal.Read

data Vector (Union a) = VectorUnion {

• vectorUnionTypesPos :: !(Vector Word8)
• vectorUnionValuesPos :: !PositionInfo
• vectorUnionReadElem :: !(Positive Word8 -> PositionInfo -> Either ReadError (Union a))

}

newtype InlineSize

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.

Constructors

InlineSize

Fields

• unInlineSize :: Word16

Instances

Bounded InlineSize

Defined in FlatBuffers.Internal.Types

Methods

minBound :: InlineSize

maxBound :: InlineSize

Enum InlineSize

Defined in FlatBuffers.Internal.Types

Methods

succ :: InlineSize -> InlineSize

pred :: InlineSize -> InlineSize

toEnum :: Int -> InlineSize

fromEnum :: InlineSize -> Int

enumFrom :: InlineSize -> [InlineSize]

enumFromThen :: InlineSize -> InlineSize -> [InlineSize]

enumFromTo :: InlineSize -> InlineSize -> [InlineSize]

enumFromThenTo :: InlineSize -> InlineSize -> InlineSize -> [InlineSize]

Eq InlineSize

Defined in FlatBuffers.Internal.Types

Methods

(==) :: InlineSize -> InlineSize -> Bool

(/=) :: InlineSize -> InlineSize -> Bool

Integral InlineSize

Defined in FlatBuffers.Internal.Types

Methods

quot :: InlineSize -> InlineSize -> InlineSize

rem :: InlineSize -> InlineSize -> InlineSize

div :: InlineSize -> InlineSize -> InlineSize

mod :: InlineSize -> InlineSize -> InlineSize

quotRem :: InlineSize -> InlineSize -> (InlineSize, InlineSize)

divMod :: InlineSize -> InlineSize -> (InlineSize, InlineSize)

toInteger :: InlineSize -> Integer

Num InlineSize

Defined in FlatBuffers.Internal.Types

Methods

(+) :: InlineSize -> InlineSize -> InlineSize

(-) :: InlineSize -> InlineSize -> InlineSize

(*) :: InlineSize -> InlineSize -> InlineSize

negate :: InlineSize -> InlineSize

abs :: InlineSize -> InlineSize

signum :: InlineSize -> InlineSize

fromInteger :: Integer -> InlineSize

Ord InlineSize

Defined in FlatBuffers.Internal.Types

Methods

compare :: InlineSize -> InlineSize -> Ordering

(<) :: InlineSize -> InlineSize -> Bool

(<=) :: InlineSize -> InlineSize -> Bool

(>) :: InlineSize -> InlineSize -> Bool

(>=) :: InlineSize -> InlineSize -> Bool

max :: InlineSize -> InlineSize -> InlineSize

min :: InlineSize -> InlineSize -> InlineSize

Real InlineSize

Defined in FlatBuffers.Internal.Types

Methods

toRational :: InlineSize -> Rational

Show InlineSize

Defined in FlatBuffers.Internal.Types

Methods

showsPrec :: Int -> InlineSize -> ShowS

show :: InlineSize -> String

showList :: [InlineSize] -> ShowS

newtype Alignment

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].

Constructors

Alignment

Fields

• unAlignment :: Word8

Instances

Bounded Alignment

Defined in FlatBuffers.Internal.Types

Methods

minBound :: Alignment

maxBound :: Alignment

Enum Alignment

Defined in FlatBuffers.Internal.Types

Methods

succ :: Alignment -> Alignment

pred :: Alignment -> Alignment

toEnum :: Int -> Alignment

fromEnum :: Alignment -> Int

enumFrom :: Alignment -> [Alignment]

enumFromThen :: Alignment -> Alignment -> [Alignment]

enumFromTo :: Alignment -> Alignment -> [Alignment]

enumFromThenTo :: Alignment -> Alignment -> Alignment -> [Alignment]

Eq Alignment

Defined in FlatBuffers.Internal.Types

Methods

(==) :: Alignment -> Alignment -> Bool

(/=) :: Alignment -> Alignment -> Bool

Integral Alignment

Defined in FlatBuffers.Internal.Types

Methods

quot :: Alignment -> Alignment -> Alignment

rem :: Alignment -> Alignment -> Alignment

div :: Alignment -> Alignment -> Alignment

mod :: Alignment -> Alignment -> Alignment

quotRem :: Alignment -> Alignment -> (Alignment, Alignment)

divMod :: Alignment -> Alignment -> (Alignment, Alignment)

toInteger :: Alignment -> Integer

Num Alignment

Defined in FlatBuffers.Internal.Types

Methods

(+) :: Alignment -> Alignment -> Alignment

(-) :: Alignment -> Alignment -> Alignment

(*) :: Alignment -> Alignment -> Alignment

negate :: Alignment -> Alignment

abs :: Alignment -> Alignment

signum :: Alignment -> Alignment

fromInteger :: Integer -> Alignment

Ord Alignment

Defined in FlatBuffers.Internal.Types

Methods

compare :: Alignment -> Alignment -> Ordering

(<) :: Alignment -> Alignment -> Bool

(<=) :: Alignment -> Alignment -> Bool

(>) :: Alignment -> Alignment -> Bool

(>=) :: Alignment -> Alignment -> Bool

max :: Alignment -> Alignment -> Alignment

min :: Alignment -> Alignment -> Alignment

Real Alignment

Defined in FlatBuffers.Internal.Types

Methods

toRational :: Alignment -> Rational

Show Alignment

Defined in FlatBuffers.Internal.Types

Methods

showsPrec :: Int -> Alignment -> ShowS

show :: Alignment -> String

showList :: [Alignment] -> ShowS

Display Alignment

Defined in FlatBuffers.Internal.Types

Methods

display :: Alignment -> String

class IsStruct a where

Metadata for a struct type.

Methods

structAlignmentOf :: Alignment

structSizeOf :: InlineSize

type ReadError = String