FlatBuffers.Internal.Read

Documentation

type ReadError = String

newtype TableIndex

Constructors

TableIndex

Fields

• unTableIndex :: Word16

Instances

Num TableIndex

Defined in FlatBuffers.Internal.Read

Methods

(+) :: TableIndex -> TableIndex -> TableIndex

(-) :: TableIndex -> TableIndex -> TableIndex

(*) :: TableIndex -> TableIndex -> TableIndex

negate :: TableIndex -> TableIndex

abs :: TableIndex -> TableIndex

signum :: TableIndex -> TableIndex

fromInteger :: Integer -> TableIndex

Show TableIndex

Defined in FlatBuffers.Internal.Read

Methods

showsPrec :: Int -> TableIndex -> ShowS

show :: TableIndex -> String

showList :: [TableIndex] -> ShowS

newtype VOffset

Constructors

VOffset

Fields

• unVOffset :: Word16

Instances

Enum VOffset

Defined in FlatBuffers.Internal.Read

Methods

succ :: VOffset -> VOffset

pred :: VOffset -> VOffset

toEnum :: Int -> VOffset

fromEnum :: VOffset -> Int

enumFrom :: VOffset -> [VOffset]

enumFromThen :: VOffset -> VOffset -> [VOffset]

enumFromTo :: VOffset -> VOffset -> [VOffset]

enumFromThenTo :: VOffset -> VOffset -> VOffset -> [VOffset]

Eq VOffset

Defined in FlatBuffers.Internal.Read

Methods

(==) :: VOffset -> VOffset -> Bool

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

Integral VOffset

Defined in FlatBuffers.Internal.Read

Methods

quot :: VOffset -> VOffset -> VOffset

rem :: VOffset -> VOffset -> VOffset

div :: VOffset -> VOffset -> VOffset

mod :: VOffset -> VOffset -> VOffset

quotRem :: VOffset -> VOffset -> (VOffset, VOffset)

divMod :: VOffset -> VOffset -> (VOffset, VOffset)

toInteger :: VOffset -> Integer

Num VOffset

Defined in FlatBuffers.Internal.Read

Methods

(+) :: VOffset -> VOffset -> VOffset

(-) :: VOffset -> VOffset -> VOffset

(*) :: VOffset -> VOffset -> VOffset

negate :: VOffset -> VOffset

abs :: VOffset -> VOffset

signum :: VOffset -> VOffset

fromInteger :: Integer -> VOffset

Ord VOffset

Defined in FlatBuffers.Internal.Read

Methods

compare :: VOffset -> VOffset -> Ordering

(<) :: VOffset -> VOffset -> Bool

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

(>) :: VOffset -> VOffset -> Bool

(>=) :: VOffset -> VOffset -> Bool

max :: VOffset -> VOffset -> VOffset

min :: VOffset -> VOffset -> VOffset

Real VOffset

Defined in FlatBuffers.Internal.Read

Methods

toRational :: VOffset -> Rational

Show VOffset

Defined in FlatBuffers.Internal.Read

Methods

showsPrec :: Int -> VOffset -> ShowS

show :: VOffset -> String

showList :: [VOffset] -> ShowS

newtype OffsetFromRoot

Constructors

OffsetFromRoot Int32

Instances

Enum OffsetFromRoot

Defined in FlatBuffers.Internal.Read

Methods

succ :: OffsetFromRoot -> OffsetFromRoot

pred :: OffsetFromRoot -> OffsetFromRoot

toEnum :: Int -> OffsetFromRoot

fromEnum :: OffsetFromRoot -> Int

enumFrom :: OffsetFromRoot -> [OffsetFromRoot]

enumFromThen :: OffsetFromRoot -> OffsetFromRoot -> [OffsetFromRoot]

enumFromTo :: OffsetFromRoot -> OffsetFromRoot -> [OffsetFromRoot]

enumFromThenTo :: OffsetFromRoot -> OffsetFromRoot -> OffsetFromRoot -> [OffsetFromRoot]

Eq OffsetFromRoot

Defined in FlatBuffers.Internal.Read

Methods

(==) :: OffsetFromRoot -> OffsetFromRoot -> Bool

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

Integral OffsetFromRoot

Defined in FlatBuffers.Internal.Read

Methods

quot :: OffsetFromRoot -> OffsetFromRoot -> OffsetFromRoot

rem :: OffsetFromRoot -> OffsetFromRoot -> OffsetFromRoot

div :: OffsetFromRoot -> OffsetFromRoot -> OffsetFromRoot

mod :: OffsetFromRoot -> OffsetFromRoot -> OffsetFromRoot

quotRem :: OffsetFromRoot -> OffsetFromRoot -> (OffsetFromRoot, OffsetFromRoot)

divMod :: OffsetFromRoot -> OffsetFromRoot -> (OffsetFromRoot, OffsetFromRoot)

toInteger :: OffsetFromRoot -> Integer

Num OffsetFromRoot

Defined in FlatBuffers.Internal.Read

Methods

(+) :: OffsetFromRoot -> OffsetFromRoot -> OffsetFromRoot

(-) :: OffsetFromRoot -> OffsetFromRoot -> OffsetFromRoot

(*) :: OffsetFromRoot -> OffsetFromRoot -> OffsetFromRoot

negate :: OffsetFromRoot -> OffsetFromRoot

abs :: OffsetFromRoot -> OffsetFromRoot

signum :: OffsetFromRoot -> OffsetFromRoot

fromInteger :: Integer -> OffsetFromRoot

Ord OffsetFromRoot

Defined in FlatBuffers.Internal.Read

Methods

compare :: OffsetFromRoot -> OffsetFromRoot -> Ordering

(<) :: OffsetFromRoot -> OffsetFromRoot -> Bool

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

(>) :: OffsetFromRoot -> OffsetFromRoot -> Bool

(>=) :: OffsetFromRoot -> OffsetFromRoot -> Bool

max :: OffsetFromRoot -> OffsetFromRoot -> OffsetFromRoot

min :: OffsetFromRoot -> OffsetFromRoot -> OffsetFromRoot

Real OffsetFromRoot

Defined in FlatBuffers.Internal.Read

Methods

toRational :: OffsetFromRoot -> Rational

Show OffsetFromRoot

Defined in FlatBuffers.Internal.Read

Methods

showsPrec :: Int -> OffsetFromRoot -> ShowS

show :: OffsetFromRoot -> String

showList :: [OffsetFromRoot] -> ShowS

data Table a

A table that is being read from a flatbuffer.

Constructors

Table

Fields

• vtable :: !Position
• tablePos :: !PositionInfo

Instances

VectorElement (Table a)

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector (Table a) :: Type

Methods

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

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

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

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

HasPosition (Vector (Table a))

Defined in FlatBuffers.Internal.Read

Methods

getPosition :: Vector (Table a) -> Position

move :: Integral i => Vector (Table a) -> i -> Vector (Table a)

newtype Vector (Table a)

Defined in FlatBuffers.Internal.Read

newtype Vector (Table a) = VectorTable PositionInfo

newtype Struct a

A struct that is being read from a flatbuffer.

Constructors

Struct

Fields

• structPos :: Position

Instances

VectorElement (Struct a)

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector (Struct a) :: Type

Methods

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

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

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

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

data Vector (Struct a)

Defined in FlatBuffers.Internal.Read

data Vector (Struct a) = VectorStruct {

• vectorStructStructSize :: !InlineSize
• vectorStructPos :: !Position

}

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) -> Either ReadError Int32

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

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

toList :: Vector (Union a) -> Either ReadError [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))

}

type Position = ByteString

data PositionInfo

Current position in the buffer

Constructors

PositionInfo

Fields

• posRoot :: !Position

  Pointer to the buffer root

• posCurrent :: !Position

  Pointer to current position

• posOffsetFromRoot :: !OffsetFromRoot

  Number of bytes between current position and root

Instances

HasPosition PositionInfo

Defined in FlatBuffers.Internal.Read

Methods

getPosition :: PositionInfo -> Position

move :: Integral i => PositionInfo -> i -> PositionInfo

class HasPosition a where

Methods

getPosition :: a -> Position

move :: Integral i => a -> i -> a

Instances

HasPosition ByteString

Defined in FlatBuffers.Internal.Read

Methods

getPosition :: ByteString -> Position

move :: Integral i => ByteString -> i -> ByteString

HasPosition PositionInfo

Defined in FlatBuffers.Internal.Read

Methods

getPosition :: PositionInfo -> Position

move :: Integral i => PositionInfo -> i -> PositionInfo

HasPosition (Vector Bool)

Defined in FlatBuffers.Internal.Read

Methods

getPosition :: Vector Bool -> Position

move :: Integral i => Vector Bool -> i -> Vector Bool

HasPosition (Vector Double)

Defined in FlatBuffers.Internal.Read

Methods

getPosition :: Vector Double -> Position

move :: Integral i => Vector Double -> i -> Vector Double

HasPosition (Vector Float)

Defined in FlatBuffers.Internal.Read

Methods

getPosition :: Vector Float -> Position

move :: Integral i => Vector Float -> i -> Vector Float

HasPosition (Vector Int8)

Defined in FlatBuffers.Internal.Read

Methods

getPosition :: Vector Int8 -> Position

move :: Integral i => Vector Int8 -> i -> Vector Int8

HasPosition (Vector Int16)

Defined in FlatBuffers.Internal.Read

Methods

getPosition :: Vector Int16 -> Position

move :: Integral i => Vector Int16 -> i -> Vector Int16

HasPosition (Vector Int32)

Defined in FlatBuffers.Internal.Read

Methods

getPosition :: Vector Int32 -> Position

move :: Integral i => Vector Int32 -> i -> Vector Int32

HasPosition (Vector Int64)

Defined in FlatBuffers.Internal.Read

Methods

getPosition :: Vector Int64 -> Position

move :: Integral i => Vector Int64 -> i -> Vector Int64

HasPosition (Vector Word8)

Defined in FlatBuffers.Internal.Read

Methods

getPosition :: Vector Word8 -> Position

move :: Integral i => Vector Word8 -> i -> Vector Word8

HasPosition (Vector Word16)

Defined in FlatBuffers.Internal.Read

Methods

getPosition :: Vector Word16 -> Position

move :: Integral i => Vector Word16 -> i -> Vector Word16

HasPosition (Vector Word32)

Defined in FlatBuffers.Internal.Read

Methods

getPosition :: Vector Word32 -> Position

move :: Integral i => Vector Word32 -> i -> Vector Word32

HasPosition (Vector Word64)

Defined in FlatBuffers.Internal.Read

Methods

getPosition :: Vector Word64 -> Position

move :: Integral i => Vector Word64 -> i -> Vector Word64

HasPosition (Vector (Table a))

Defined in FlatBuffers.Internal.Read

Methods

getPosition :: Vector (Table a) -> Position

move :: Integral i => Vector (Table a) -> i -> Vector (Table a)

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

checkFileIdentifier' :: FileIdentifier -> ByteString -> Bool

moveToElem :: HasPosition pos => pos -> Int32 -> Int32 -> pos

checkIndexBounds :: Int32 -> Int32 -> Int32

inlineVectorToList :: HasPosition pos => Get a -> pos -> Either ReadError [a]

class VectorElement a where

Minimal complete definition

length, unsafeIndex, toList

Associated Types

data Vector a

A vector that is being read from a flatbuffer.

Methods

length :: Vector a -> Either ReadError Int32

Returns the size of the vector.

index :: Vector a -> Int32 -> Either ReadError a

Returns the item at the given index. If the given index is negative or too large, an error is thrown.

unsafeIndex :: Vector a -> Int32 -> Either ReadError a

Returns the item at the given index without performing the bounds check.

Given an invalid index, unsafeIndex will likely read garbage data or return a ReadError. In the case of Vector Word8, using a negative index carries the same risks as unsafeIndex (i.e. reading from outside the buffer's boundaries).

toList :: Vector a -> Either ReadError [a]

Converts the vector to a list.

Instances

VectorElement Bool

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector Bool :: Type

Methods

length :: Vector Bool -> Either ReadError Int32

index :: Vector Bool -> Int32 -> Either ReadError Bool

unsafeIndex :: Vector Bool -> Int32 -> Either ReadError Bool

toList :: Vector Bool -> Either ReadError [Bool]

VectorElement Double

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector Double :: Type

Methods

length :: Vector Double -> Either ReadError Int32

index :: Vector Double -> Int32 -> Either ReadError Double

unsafeIndex :: Vector Double -> Int32 -> Either ReadError Double

toList :: Vector Double -> Either ReadError [Double]

VectorElement Float

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector Float :: Type

Methods

length :: Vector Float -> Either ReadError Int32

index :: Vector Float -> Int32 -> Either ReadError Float

unsafeIndex :: Vector Float -> Int32 -> Either ReadError Float

toList :: Vector Float -> Either ReadError [Float]

VectorElement Int8

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector Int8 :: Type

Methods

length :: Vector Int8 -> Either ReadError Int32

index :: Vector Int8 -> Int32 -> Either ReadError Int8

unsafeIndex :: Vector Int8 -> Int32 -> Either ReadError Int8

toList :: Vector Int8 -> Either ReadError [Int8]

VectorElement Int16

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector Int16 :: Type

Methods

length :: Vector Int16 -> Either ReadError Int32

index :: Vector Int16 -> Int32 -> Either ReadError Int16

unsafeIndex :: Vector Int16 -> Int32 -> Either ReadError Int16

toList :: Vector Int16 -> Either ReadError [Int16]

VectorElement Int32

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector Int32 :: Type

Methods

length :: Vector Int32 -> Either ReadError Int32

index :: Vector Int32 -> Int32 -> Either ReadError Int32

unsafeIndex :: Vector Int32 -> Int32 -> Either ReadError Int32

toList :: Vector Int32 -> Either ReadError [Int32]

VectorElement Int64

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector Int64 :: Type

Methods

length :: Vector Int64 -> Either ReadError Int32

index :: Vector Int64 -> Int32 -> Either ReadError Int64

unsafeIndex :: Vector Int64 -> Int32 -> Either ReadError Int64

toList :: Vector Int64 -> Either ReadError [Int64]

VectorElement Word8

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector Word8 :: Type

Methods

length :: Vector Word8 -> Either ReadError Int32

index :: Vector Word8 -> Int32 -> Either ReadError Word8

unsafeIndex :: Vector Word8 -> Int32 -> Either ReadError Word8

toList :: Vector Word8 -> Either ReadError [Word8]

VectorElement Word16

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector Word16 :: Type

Methods

length :: Vector Word16 -> Either ReadError Int32

index :: Vector Word16 -> Int32 -> Either ReadError Word16

unsafeIndex :: Vector Word16 -> Int32 -> Either ReadError Word16

toList :: Vector Word16 -> Either ReadError [Word16]

VectorElement Word32

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector Word32 :: Type

Methods

length :: Vector Word32 -> Either ReadError Int32

index :: Vector Word32 -> Int32 -> Either ReadError Word32

unsafeIndex :: Vector Word32 -> Int32 -> Either ReadError Word32

toList :: Vector Word32 -> Either ReadError [Word32]

VectorElement Word64

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector Word64 :: Type

Methods

length :: Vector Word64 -> Either ReadError Int32

index :: Vector Word64 -> Int32 -> Either ReadError Word64

unsafeIndex :: Vector Word64 -> Int32 -> Either ReadError Word64

toList :: Vector Word64 -> Either ReadError [Word64]

VectorElement Text

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector Text :: Type

Methods

length :: Vector Text -> Either ReadError Int32

index :: Vector Text -> Int32 -> Either ReadError Text

unsafeIndex :: Vector Text -> Int32 -> Either ReadError Text

toList :: Vector Text -> Either ReadError [Text]

VectorElement (Union a)

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector (Union a) :: Type

Methods

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

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

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

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

VectorElement (Struct a)

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector (Struct a) :: Type

Methods

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

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

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

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

VectorElement (Table a)

Defined in FlatBuffers.Internal.Read

Associated Types

data Vector (Table a) :: Type

Methods

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

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

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

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

readStructField :: (Position -> a) -> VOffset -> Struct s -> a

readTableFieldOpt :: (PositionInfo -> Either ReadError a) -> TableIndex -> Table t -> Either ReadError (Maybe a)

readTableFieldReq :: (PositionInfo -> Either ReadError a) -> TableIndex -> String -> Table t -> Either ReadError a

readTableFieldWithDef :: (PositionInfo -> Either ReadError a) -> TableIndex -> a -> Table t -> Either ReadError a

readTableFieldUnion :: (Positive Word8 -> PositionInfo -> Either ReadError (Union a)) -> TableIndex -> Table t -> Either ReadError (Union a)

readTableFieldUnionVectorOpt :: (Positive Word8 -> PositionInfo -> Either ReadError (Union a)) -> TableIndex -> Table t -> Either ReadError (Maybe (Vector (Union a)))

readTableFieldUnionVectorReq :: (Positive Word8 -> PositionInfo -> Either ReadError (Union a)) -> TableIndex -> String -> Table t -> Either ReadError (Vector (Union a))

readInt8 :: HasPosition a => a -> Either ReadError Int8

readInt16 :: HasPosition a => a -> Either ReadError Int16

readInt32 :: HasPosition a => a -> Either ReadError Int32

readInt64 :: HasPosition a => a -> Either ReadError Int64

readWord8 :: HasPosition a => a -> Either ReadError Word8

readWord16 :: HasPosition a => a -> Either ReadError Word16

readWord32 :: HasPosition a => a -> Either ReadError Word32

readWord64 :: HasPosition a => a -> Either ReadError Word64

readFloat :: HasPosition a => a -> Either ReadError Float

readDouble :: HasPosition a => a -> Either ReadError Double

readBool :: HasPosition a => a -> Either ReadError Bool

word8ToBool :: Word8 -> Bool

readPrimVector :: (Position -> Vector a) -> PositionInfo -> Either ReadError (Vector a)

readTableVector :: PositionInfo -> Either ReadError (Vector (Table a))

readStructVector :: forall a. IsStruct a => PositionInfo -> Either ReadError (Vector (Struct a))

readUnionVector :: (Positive Word8 -> PositionInfo -> Either ReadError (Union a)) -> PositionInfo -> PositionInfo -> Either ReadError (Vector (Union a))

readText :: HasPosition a => a -> Either ReadError Text

Follow a pointer to the position of a string and read it.

readText' :: Get (Either ReadError Text)

Read a string from the current buffer position.

readTable :: PositionInfo -> Either ReadError (Table t)

Follow a pointer to the position of a table and read it.

readTable' :: PositionInfo -> Either ReadError (Table t)

Read a table from the current buffer position.

readStruct :: HasPosition a => a -> Struct s

tableIndexToVOffset :: Table t -> TableIndex -> Either ReadError (Maybe VOffset)

readUOffsetAndSkip :: HasPosition pos => pos -> Either ReadError pos

runGet :: Get a -> ByteString -> Either ReadError a

missingField :: String -> Either ReadError a

byteStringSafeIndex :: ByteString -> Int32 -> Either ReadError Word8

Safer version of index that doesn't throw when index is too large. Assumes i > 0.