FlatBuffers.Internal.FileIdentifier

Documentation

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

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

fileIdentifier :: Text -> Maybe FileIdentifier

Encodes the input text as UTF-8 and returns a Just FileIdentifier if it has exactly 4 bytes, otherwise Nothing.

fileIdentifier' :: ByteString -> Maybe FileIdentifier

Returns a Just FileIdentifier if the input ByteString has exactly 4 bytes, otherwise Nothing.

unsafeFileIdentifier :: Text -> FileIdentifier

Constructs a new FileIdentifier without checking its length.

unsafeFileIdentifier' :: ByteString -> FileIdentifier

Constructs a new FileIdentifier without checking its length.