Data.Binary.Получить

+------------------+--------------+-----------------+
| 32 bit timestamp | 32 bit price | 16 bit quantity |
+------------------+--------------+-----------------+

data Trade = Trade
  { timestamp :: !Word32
  , price     :: !Word32
  , qty       :: !Word16
  } deriving (Show)
 

getTrade :: Get Trade
getTrade = do
  timestamp <- getWord32le
  price     <- getWord32le
  quantity  <- getWord16le
  return $! Trade timestamp price quantity
 

getTrade' :: Get Trade
getTrade' = Trade <$> getWord32le <*> getWord32le <*> getWord16le
 

getTrades :: Get [Trade]
getTrades = do
  empty <- isEmpty
  if empty
    then return []
    else do trade <- getTrade
            trades <- getTrades
            return (trade:trades)
 

lazyIOExample :: IO [Trade]
lazyIOExample = do
  input <- BL.readFile "trades.bin"
  return (runGet getTrades input)
 

incrementalExample :: BL.ByteString -> [Trade]
incrementalExample input0 = go decoder input0
  where
    decoder = runGetIncremental getTrade
    go :: Decoder Trade -> BL.ByteString -> [Trade]
    go (Done leftover _consumed trade) input =
      trade : go decoder (BL.chunk leftover input)
    go (Partial k) input                     =
      go (k . takeHeadChunk $ input) (dropHeadChunk input)
    go (Fail _leftover _consumed msg) _input =
      error msg

takeHeadChunk :: BL.ByteString -> Maybe BS.ByteString
takeHeadChunk lbs =
  case lbs of
    (BL.Chunk bs _) -> Just bs
    _ -> Nothing

dropHeadChunk :: BL.ByteString -> BL.ByteString
dropHeadChunk lbs =
  case lbs of
    (BL.Chunk _ lbs') -> lbs'
    _ -> BL.Empty
 

Моноид Get

data Get a Источник

Ленивый интерфейс ввода

Ленивый интерфейс потребляет один ленивый ByteString. Это самый простой интерфейс для начала работы, но он не поддерживает вложение ввода-вывода и разбора, если не используется ленивое ввод-вывод.

Нет способа предоставить больше ввода, кроме начальных данных. Чтобы иметь возможность по частям предоставлять данные, см. инкрементальный интерфейс ввода.

runGet :: Get a -> ByteString -> a Источник

Самый простой интерфейс для запуска декодера Get. Если декодер столкнётся с ошибкой, вызовет fail, или закончится вводом, он вызовет error.

runGetOrFail :: Get a -> ByteString -> Either (ByteString, СмещениеБайта, Строка) (ByteString, СмещениеБайта, a) Источник

Запуск моноида Get и возврат Left при ошибке и Right при успехе. В обоих случаях возвращается неиспользованный ввод и количество израсходованных байтов. В случае ошибки также включается удобочитаемое сообщение об ошибке.

type СмещениеБайта = Int64 Источник

Смещение, отсчитываемое в байтах.

Инкрементальный интерфейс ввода

Инкрементальный интерфейс даёт вам больший контроль над тем, как предоставляется ввод во время разбора. Это позволяет, например, вкладывать ввод-вывод и разбор.

Инкрементальный интерфейс потребляет жёсткий ByteString за раз, каждый из которых является частью общего количества ввода. Если вашему декодеру нужен дополнительный ввод для завершения, он вернёт Partial с продолжением. Если больше нет ввода, предоставьте Nothing.

Fail вернётся, если произойдет ошибка, вместе с сообщением, позицией и оставшимся вводом. Если всё успешно, будет возвращено Done с результирующим значением, позицией и оставшимся вводом.

data Декодер a Источник

Декодер, полученный при запуске моноида Get. См. Decoder для дальнейших действий, таких как предоставление ввода, обработка ошибок декодера и получение выходного значения. Подсказка: Используйте вспомогательные функции pushChunk, pushChunks и pushEndOfInput.

runGetIncremental :: Get a -> Декодер a Источник

Запуск моноида Get. См. Decoder для следующих шагов, таких как предоставление ввода, обработка ошибок декодера и получение выходного значения. Подсказка: Используйте вспомогательные функции pushChunk, pushChunks и pushEndOfInput.

Предоставление ввода

pushChunk :: Декодер a -> ByteString -> Декодер a Источник

Предоставление декодеру Decoder большего ввода. Если Decoder — Done или Fail, он добавит ввод к ByteString неиспользованного ввода.

   runGetIncremental myParser `pushChunk` myInput1 `pushChunk` myInput2

pushChunks :: Декодер a -> ByteString -> Декодер a Источник

Предоставление декодеру Decoder большего ввода. Если Decoder — Done или Fail, он добавит ввод к ByteString неиспользованного ввода.

   runGetIncremental myParser `pushChunks` myLazyByteString

pushEndOfInput :: Декодер a -> Декодер a Источник

Сообщите Decoder, что больше нет входных данных. Это передаёт Nothing декодеру Partial, в противном случае возвращает декодер без изменений.

Декодирование

skip :: Int -> Get () Исходный код

Пропустить вперёд n байтов. Возникает ошибка, если доступно меньше n байтов.

isEmpty :: Get Bool Исходный код

Проверить, были ли потреблены все входные данные, т.е. не осталось нераскодированных байтов.

bytesRead :: Get Int64 Исходный код

Получить общее количество считанных байтов на данный момент.

isolate Исходный код

Изолировать декодер для работы с фиксированным количеством байтов и возвращать ошибку, если потреблялось меньше или пытались потребить больше байтов. Если указанный декодер возвращает ошибку, то и функция isolate также вернёт ошибку. Смещение от bytesRead будет относиться к началу isolate, а не к абсолютному началу входных данных.

lookAhead :: Get a -> Get a Исходный код

Запустить указанный декодер, но не потреблять его входные данные. Если указанный декодер возвращает ошибку, то и эта функция тоже вернёт ошибку.

lookAheadM :: Get (Maybe a) -> Get (Maybe a) Исходный код

Запустить заданный декодер и потребить его входные данные только если он вернёт Just. Если вернётся Nothing, входные данные останутся непотребленными. Если заданный декодер возвращает ошибку, то и эта функция тоже вернёт ошибку.

lookAheadE :: Get (Either a b) -> Get (Either a b) Исходный код

Запустить заданный декодер и потреблять его входные данные только если он вернёт Right. Если вернётся Left, входные данные останутся непотребленными. Если заданный декодер возвращает ошибку, то и эта функция тоже вернёт ошибку.

label :: String -> Get a -> Get a Исходный код

Массивы байтов

getByteString :: Int -> Get ByteString Исходный код

Эффективный метод get для строгих массивов байтов. Возникает ошибка, если осталось меньше n байтов во входных данных. Если n <= 0, то возвращается пустая строка.

getLazyByteString :: Int64 -> Get ByteString Исходный код

Эффективный метод get для ленивых массивов байтов. Возникает ошибка, если осталось меньше n байтов во входных данных.

getLazyByteStringNul :: Get ByteString Исходный код

Получить ленивый массив байтов, завершаемый байтом NULL. Возвращаемая строка не содержит байт NULL. Возникает ошибка, если достигнут конец входных данных, не найдя байт NULL.

getRemainingLazyByteString :: Get ByteString Исходный код

Получить оставшиеся байты в виде ленивого массива байтов. Обратите внимание, что это может быть дорогостоящая функция, так как она заставляет читать все входные данные и сохранять строку в памяти.

Декодирование слов

getWord8 :: Get Word8 Исходный код

Считать Word8 из состояния монады.

Декодирование в формате big-endian

getWord16be :: Get Word16 Исходный код

Считать Word16 в формате big-endian.

getWord32be :: Get Word32 Исходный код

Считать Word32 в формате big-endian.

getWord64be :: Get Word64 Исходный код

Считать Word64 в формате big-endian.

Декодирование в формате little-endian

getWord16le :: Get Word16 Исходный код

Считать Word16 в формате little-endian.

getWord32le :: Get Word32 Исходный код

Считать Word32 в формате little-endian.

getWord64le :: Get Word64 Исходный код

Считать Word64 в формате little-endian.

Декодирование в формате host-endian, без выравнивания

getWordhost :: Get Word Исходный код

O(1). Считать одно слово, используемое на текущей машине. Слово читается в порядке, принятом для текущей машины, в формате host-endian. На 64-битной машине Word — значение в 8 байтов, на 32-битной машине — 4 байта.

getWord16host :: Get Word16 Исходный код

O(1). Считать 2-байтовое Word16 в порядке host-order и формате host-endian.

getWord32host :: Get Word32 Исходный код

O(1). Считать Word32 в порядке host-order и формате host-endian.

getWord64host :: Get Word64 Исходный код

O(1). Считать Word64 в порядке host-order и формате host-endian.

Функции, устаревшие

runGetState :: Get a -> ByteString -> ByteOffset -> (a, ByteString, ByteOffset) Исходный код

УСТАРЕВШЕЕ. Обеспечивает совместимость с предыдущими версиями этой библиотеки. Выполняет Get монаду и возвращает кортеж с тремя значениями. Первое значение — результат декодера. Второе и третье — неиспользованный ввод и количество прочитанных байтов.

remaining :: Get Int64 Источник

УСТАРЕВШЕЕ. Получает количество байтов оставшегося ввода. Обратите внимание, что эта функция является дорогостоящей, поскольку для расчета оставшегося ввода необходимо прочитать весь ввод и сохранить его в памяти. Декодер сохраняет ввод как строгую строку байтов, поэтому вам, вероятно, лучше рассчитать оставшийся ввод другим способом.

getBytes :: Int -> Get ByteString Источник

УСТАРЕВШЕЕ. То же, что и getByteString.