FlatBuffers.Internal.Write

Documentation

type BufferSize = Sum Int32

type Position = Int32

The position of something in a buffer, expressed as the number of bytes counting from the end.

data FBState

Constructors

FBState

Fields

• builder :: !Builder
• bufferSize :: !BufferSize
• maxAlign :: !(Max Alignment)
• cache :: !(Map ByteString Position)

newtype WriteTableField

Constructors

WriteTableField

Fields

• unWriteTableField :: State FBState (FBState -> FBState)

newtype WriteStruct a

A struct to be written to a flatbuffer.

Constructors

WriteStruct

Fields

• buildStruct :: Builder

Instances

IsStruct a => WriteVectorElement (WriteStruct a)

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector (WriteStruct a) :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f (WriteStruct a) -> WriteVector (WriteStruct a)

newtype WriteVector (WriteStruct a)

Defined in FlatBuffers.Internal.Write

newtype WriteVector (WriteStruct a) = WriteVectorStruct {

• writeVectorStructTableField :: WriteTableField

}

newtype WriteTable a

A table to be written to a flatbuffer.

Constructors

WriteTable (State FBState Position)

Instances

WriteVectorElement (WriteTable a)

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector (WriteTable a) :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f (WriteTable a) -> 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.

Constructors

Some !Word8 !(State FBState Position)

None

Instances

WriteVectorElement (WriteUnion a)

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector (WriteUnion a) :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f (WriteUnion a) -> WriteVector (WriteUnion a)

data WriteVector (WriteUnion a)

Defined in FlatBuffers.Internal.Write

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

encode :: WriteTable a -> ByteString

Serializes a flatbuffer table as a lazy ByteString.

encodeState :: FBState -> WriteTable a -> ByteString

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

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

encodeStateWithFileIdentifier :: FBState -> FileIdentifier -> WriteTable a -> ByteString

write :: Int32 -> Builder -> FBState -> FBState

Writes something (unaligned) to the buffer.

writeInt32 :: Int32 -> FBState -> FBState

Writes a 32-bit int (unaligned) to the buffer.

writeFileIdentifier :: FileIdentifier -> FBState -> FBState

missing :: WriteTableField

deprecated :: WriteTableField

optional :: (a -> WriteTableField) -> Maybe a -> WriteTableField

optionalDef :: Eq a => a -> (a -> WriteTableField) -> Maybe a -> WriteTableField

writeWord8TableField :: Word8 -> WriteTableField

writeWord16TableField :: Word16 -> WriteTableField

writeWord32TableField :: Word32 -> WriteTableField

writeWord64TableField :: Word64 -> WriteTableField

writeInt8TableField :: Int8 -> WriteTableField

writeInt16TableField :: Int16 -> WriteTableField

writeInt32TableField :: Int32 -> WriteTableField

writeInt64TableField :: Int64 -> WriteTableField

writeFloatTableField :: Float -> WriteTableField

writeDoubleTableField :: Double -> WriteTableField

writeBoolTableField :: Bool -> WriteTableField

writeTextTableField :: Text -> WriteTableField

writeTableTableField :: WriteTable a -> WriteTableField

writeStructTableField :: forall a. IsStruct a => WriteStruct a -> WriteTableField

writeStructTableField' :: Alignment -> InlineSize -> Builder -> WriteTableField

writeUnionTypesVectorTableField :: WriteVector (WriteUnion a) -> WriteTableField

writeUnionValuesVectorTableField :: WriteVector (WriteUnion a) -> WriteTableField

writeUnionTypeTableField :: WriteUnion a -> WriteTableField

writeUnionValueTableField :: WriteUnion a -> WriteTableField

none :: WriteUnion a

Constructs a missing union table field / vector element.

writeUnion :: Word8 -> WriteTable a -> WriteUnion b

vtable :: [Word16] -> Word16 -> ByteString

writeTable :: [WriteTableField] -> WriteTable a

class WriteVectorElement a where

Associated Types

data WriteVector a

A vector to be written to a flatbuffer.

Methods

fromFoldable

Arguments

:: Foldable f

=> Int32

n: the number of elements in xs

-> f a

xs: a collection

-> WriteVector a

Constructs a flatbuffers vector.

If n is larger than the length of xs, this will result in a malformed buffer. If n is smaller than the length of xs, all elements of xs will still be written to the buffer, but the client will only be able to read the first n elements.

Note: fromFoldable asks for the collection's length to be passed in as an argument rather than use Foldable.length because:

1. Foldable.length is often O(n), and in some use cases there may be a better way to know the collection's length ahead of time.
2. Calling Foldable.length inside fromFoldable can inhibit some fusions which would otherwise be possible.

Instances

WriteVectorElement Bool

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector Bool :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f Bool -> WriteVector Bool

WriteVectorElement Double

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector Double :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f Double -> WriteVector Double

WriteVectorElement Float

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector Float :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f Float -> WriteVector Float

WriteVectorElement Int8

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector Int8 :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f Int8 -> WriteVector Int8

WriteVectorElement Int16

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector Int16 :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f Int16 -> WriteVector Int16

WriteVectorElement Int32

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector Int32 :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f Int32 -> WriteVector Int32

WriteVectorElement Int64

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector Int64 :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f Int64 -> WriteVector Int64

WriteVectorElement Word8

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector Word8 :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f Word8 -> WriteVector Word8

WriteVectorElement Word16

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector Word16 :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f Word16 -> WriteVector Word16

WriteVectorElement Word32

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector Word32 :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f Word32 -> WriteVector Word32

WriteVectorElement Word64

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector Word64 :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f Word64 -> WriteVector Word64

WriteVectorElement Text

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector Text :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f Text -> WriteVector Text

WriteVectorElement (WriteUnion a)

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector (WriteUnion a) :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f (WriteUnion a) -> WriteVector (WriteUnion a)

WriteVectorElement (WriteTable a)

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector (WriteTable a) :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f (WriteTable a) -> WriteVector (WriteTable a)

IsStruct a => WriteVectorElement (WriteStruct a)

Defined in FlatBuffers.Internal.Write

Associated Types

data WriteVector (WriteStruct a) :: Type

Methods

fromFoldable :: Foldable f => Int32 -> f (WriteStruct a) -> WriteVector (WriteStruct a)

fromFoldable' :: WriteVectorElement a => Foldable f => f a -> WriteVector a

Convenience function, equivalent to:

fromFoldable' xs = fromFoldable (fromIntegral (Foldable.length xs)) xs

In some cases it may be slower than using fromFoldable directly.

fromList :: WriteVectorElement a => Int32 -> [a] -> WriteVector a

fromFoldable specialized to list

fromList' :: WriteVectorElement a => [a] -> WriteVector a

fromFoldable' specialized to list

singleton :: WriteVectorElement a => a -> WriteVector a

Creates a flatbuffers vector with a single element

empty :: WriteVectorElement a => WriteVector a

Creates an empty flatbuffers vector

inlineVector :: Foldable f => (a -> Builder) -> Alignment -> InlineSize -> Int32 -> f a -> WriteTableField

data TextInfos

Constructors

TextInfos ![TextInfo] !BufferSize

data TextInfo

Constructors

TextInfo

Fields

• tiText :: !Text
• tiUtf8len :: !Int32
• tiPadding :: !Int32
• tiPosition :: !Position

data OffsetInfo

Constructors

OffsetInfo

Fields

• oiIndex :: !Int32
• oiOffsets :: ![Int32]

data TableInfo

Constructors

TableInfo

Fields

• tiState :: !FBState
• tiTablePositions :: ![Position]

data Vecs a

Constructors

Vecs ![Word8] ![Maybe (State FBState Position)]

data UnionTableInfo

Constructors

UnionTableInfo

Fields

• utiState :: !FBState
• utiTablePositions :: ![Maybe Position]

calcPadding

Arguments

:: Alignment

n

-> Int32

additionalBytes

-> BufferSize

-> Int32

Calculate how much 0-padding is needed so that, after writing additionalBytes, the buffer becomes aligned to n bytes.

alignTo

Arguments

:: Alignment

n

-> Int32

additionalBytes

-> FBState

-> FBState

Add enough 0-padding so that the buffer becomes aligned to n after writing additionalBytes.

uoffsetFromHere :: State FBState (FBState -> FBState)

uoffsetFrom :: Position -> FBState -> FBState

utf8length :: Text -> Int32

c_length_utf8 :: ByteArray# -> CSize -> CSize -> IO Int32