Telescope.Asdf.Encoding.File

Documentation

splitAsdfFile :: forall (es :: [Effect]). Error AsdfError :> es => ByteString -> Eff es AsdfFile

Split an encoded ByteString into a Tree, '[Encoded Block]' and 'Encoded Index'

parseAsdfFile :: forall (es :: [Effect]). (State ByteString :> es, Fail :> es) => Eff es AsdfFile

Lightweight first-pass parsing using 'State ByteString' instead of Parsec or similar

parseTree :: forall (es :: [Effect]). (State ByteString :> es, NonDet :> es) => Eff es (Encoded Tree)

parseIndex :: forall (es :: [Effect]). State ByteString :> es => Eff es (Encoded Index)

parseBlocks :: forall (es :: [Effect]). (State ByteString :> es, NonDet :> es) => Eff es [Encoded Block]

parseBlock :: forall (es :: [Effect]). (State ByteString :> es, NonDet :> es) => Eff es (Encoded Block)

exactly :: forall (es :: [Effect]). (State ByteString :> es, NonDet :> es) => ByteString -> Eff es ()

parseUntil :: forall (es :: [Effect]). (State ByteString :> es, NonDet :> es) => ByteString -> Eff es ByteString

nonEmpty :: forall (es :: [Effect]). (NonDet :> es, State ByteString :> es) => Eff es ByteString

remainingBytes :: forall (es :: [Effect]). (NonDet :> es, State ByteString :> es) => Eff es ByteString

breakIndex :: forall (es :: [Effect]). State ByteString :> es => Eff es (Encoded Index)

concatAsdfFile :: AsdfFile -> ByteString

encodeTree :: ByteString -> Encoded Tree

encodeBlocks :: [BlockData] -> [Encoded Block]

encodeBlock :: BlockData -> Encoded Block

encodeIndex :: BlockIndex -> Encoded Index

data Index

data Block

newtype Encoded (a :: k)

values that have been encoded to the file format: padding, etc

Constructors

Encoded

Fields

• bytes :: ByteString

Instances

IsString (Encoded a)

Defined in Telescope.Asdf.Encoding.File

Methods

fromString :: String -> Encoded a

Show (Encoded a)

Defined in Telescope.Asdf.Encoding.File

Methods

showsPrec :: Int -> Encoded a -> ShowS

show :: Encoded a -> String

showList :: [Encoded a] -> ShowS

Eq (Encoded a)

Defined in Telescope.Asdf.Encoding.File

Methods

(==) :: Encoded a -> Encoded a -> Bool

(/=) :: Encoded a -> Encoded a -> Bool

newtype BlockData

Decompressed block data

Constructors

BlockData

Fields

• bytes :: ByteString

Instances

Show BlockData

Defined in Telescope.Asdf.Encoding.File

Methods

showsPrec :: Int -> BlockData -> ShowS

show :: BlockData -> String

showList :: [BlockData] -> ShowS

Eq BlockData

Defined in Telescope.Asdf.Encoding.File

Methods

(==) :: BlockData -> BlockData -> Bool

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

newtype BlockSource

Constructors

BlockSource Int

Instances

Eq BlockSource

Defined in Telescope.Asdf.Encoding.File

Methods

(==) :: BlockSource -> BlockSource -> Bool

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

ToAsdf BlockSource

Defined in Telescope.Asdf.Class

Methods

toValue :: BlockSource -> Value

schema :: BlockSource -> SchemaTag

anchor :: BlockSource -> Maybe Anchor

toNode :: BlockSource -> Node

data BlockHeader

Constructors

BlockHeader

Fields

• headerSize :: Word16
• flags :: Word32
• compression :: Compression
• allocatedSize :: Word64
• usedSize :: Word64
• dataSize :: Word64
• checksum :: Checksum

Instances

Show BlockHeader

Defined in Telescope.Asdf.Encoding.File

Methods

showsPrec :: Int -> BlockHeader -> ShowS

show :: BlockHeader -> String

showList :: [BlockHeader] -> ShowS

Eq BlockHeader

Defined in Telescope.Asdf.Encoding.File

Methods

(==) :: BlockHeader -> BlockHeader -> Bool

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

newtype BlockIndex

Constructors

BlockIndex [Int]

Instances

Eq BlockIndex

Defined in Telescope.Asdf.Encoding.File

Methods

(==) :: BlockIndex -> BlockIndex -> Bool

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

data Compression

Constructors

NoCompression

ZLib

BZip2

Instances

Show Compression

Defined in Telescope.Asdf.Encoding.File

Methods

showsPrec :: Int -> Compression -> ShowS

show :: Compression -> String

showList :: [Compression] -> ShowS

Eq Compression

Defined in Telescope.Asdf.Encoding.File

Methods

(==) :: Compression -> Compression -> Bool

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

newtype Checksum

Constructors

Checksum ByteString

Instances

Show Checksum

Defined in Telescope.Asdf.Encoding.File

Methods

showsPrec :: Int -> Checksum -> ShowS

show :: Checksum -> String

showList :: [Checksum] -> ShowS

Eq Checksum

Defined in Telescope.Asdf.Encoding.File

Methods

(==) :: Checksum -> Checksum -> Bool

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

noChecksum :: Checksum

data AsdfFile

Constructors

AsdfFile

Fields

• tree :: Encoded Tree
• blocks :: [Encoded Block]
• index :: Encoded Index

Instances

Show AsdfFile

Defined in Telescope.Asdf.Encoding.File

Methods

showsPrec :: Int -> AsdfFile -> ShowS

show :: AsdfFile -> String

showList :: [AsdfFile] -> ShowS

Eq AsdfFile

Defined in Telescope.Asdf.Encoding.File

Methods

(==) :: AsdfFile -> AsdfFile -> Bool

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

getBlock :: Get BlockData

getBlocks :: Get [BlockData]

Skip along blocks and create a list of all of them

getBlockHeader :: Get BlockHeader

putBlockHeader :: BlockHeader -> Put

blockIndex :: Encoded Tree -> [Encoded Block] -> BlockIndex

putBlock :: BlockData -> Put

blockHeader :: BlockData -> BlockHeader

getBlockData :: BlockHeader -> Get BlockData

blockMagicToken :: ByteString

blockIndexHeader :: ByteString

checkMagicToken :: Get Bool

Verify that the magic token is next without consuming any input

getMagicToken :: Get (Either ByteString ())

consume the magic token if available