Dahdit.Run

Documentation

data GetError

Constructors

GetErrorLocalCap !Text !ByteCount !ByteCount

GetErrorScopedMismatch !ScopeMode !ByteCount !ByteCount

GetErrorFail !Text

GetErrorGlobalCap !Text !ByteCount !ByteCount

GetErrorRemaining !ByteCount

Instances

Exception GetError

Defined in Dahdit.Run

Methods

toException :: GetError -> SomeException

fromException :: SomeException -> Maybe GetError

displayException :: GetError -> String

Show GetError

Defined in Dahdit.Run

Methods

showsPrec :: Int -> GetError -> ShowS

show :: GetError -> String

showList :: [GetError] -> ShowS

Eq GetError

Defined in Dahdit.Run

Methods

(==) :: GetError -> GetError -> Bool

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

prettyGetError :: GetError -> Text

runGetInternal :: ReadMem r m => ByteCount -> Get a -> ByteCount -> r -> m (Either GetError a, ByteCount)

Get from a single buffer

data GetIncEnv s r

Constructors

GetIncEnv

Fields

• gieGlobalAbs :: !(MutVar s ByteCount)

  Offset from start of parsing (0) to current position

• gieGlobalRel :: !(MutVar s ByteCount)

  Offset from start of parsing (0) to start of buffer It will always be the case that gloRel <= gloAbs

• gieGlobalCap :: !(MutVar s (Seq ByteCount))

  Stack of maximum capcacity (across all chunks) Top of stack is end of sequence. This will be narrowed to check scoped length.

• gieCurChunk :: !(MutVar s (GetIncChunk r))

  Current chunk

• gieLookAhead :: !(MutVar s (Seq ByteCount))

  Stack of look ahead points (in absolute position) Top of stack is end of sequence.

newGetIncEnv :: MonadPrim s m => Maybe ByteCount -> GetIncChunk r -> m (GetIncEnv s r)

data GetIncChunk r

Constructors

GetIncChunk

Fields

• gicLocalOff :: !ByteCount

  Offset from start of local buffer to data

• gicLocalCap :: !ByteCount

  Capacity of local buffer

• gicArray :: !r

  Source buffer

data GetIncRequest

A request for more data. Includes absolute position, offset in the current buffer, and required length.

Constructors

GetIncRequest

Fields

• girAbsPos :: !ByteCount
• girBaseOff :: !ByteCount
• girNeedLength :: !ByteCount

Instances

Show GetIncRequest

Defined in Dahdit.Run

Methods

showsPrec :: Int -> GetIncRequest -> ShowS

show :: GetIncRequest -> String

showList :: [GetIncRequest] -> ShowS

Eq GetIncRequest

Defined in Dahdit.Run

Methods

(==) :: GetIncRequest -> GetIncRequest -> Bool

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

Ord GetIncRequest

Defined in Dahdit.Run

Methods

compare :: GetIncRequest -> GetIncRequest -> Ordering

(<) :: GetIncRequest -> GetIncRequest -> Bool

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

(>) :: GetIncRequest -> GetIncRequest -> Bool

(>=) :: GetIncRequest -> GetIncRequest -> Bool

max :: GetIncRequest -> GetIncRequest -> GetIncRequest

min :: GetIncRequest -> GetIncRequest -> GetIncRequest

data GetIncSuspend z x

See GetIncCb - this is the functor-ized version so we can suspend execution.

Constructors

GetIncSuspend !GetIncRequest !(Maybe z -> x)

Instances

Functor (GetIncSuspend z)

Defined in Dahdit.Run

Methods

fmap :: (a -> b) -> GetIncSuspend z a -> GetIncSuspend z b

(<$) :: a -> GetIncSuspend z b -> GetIncSuspend z a

type GetIncCb z m = GetIncRequest -> m (Maybe z)

Return new chunk containing enough data (or nothing).

runGetIncInternal :: (MonadPrim s m, ReadMem r m) => Get a -> GetIncEnv s r -> GetIncCbChunk r m -> m (Either GetError a, ByteCount, ByteCount)

runCount :: Put -> ByteCount

runPutInternal :: WriteMem q m => ByteCount -> Put -> ByteCount -> q (PrimState m) -> m ByteCount