package batteries

  1. Overview
  2. Docs
A community-maintained standard library extension

Install 

dune-project
 Dependency

github.com Readme Edit opam file Versions (15)

Authors

  1. O
    OCaml batteries-included team

Maintainers

  1. C
    Cedric Cellier <rixed@happyleptic.org>
  2. F
    Francois Berenger <unixjunkie@sdf.org>
  3. Gabriel Scherer
  4. T
    Thibault Suzanne <thi.suzanne@gmail.com>
  5. S
    Simmo Saan <simmo.saan@gmail.com>

Sources

v3.7.1.tar.gz
md5=d02c4f044e53edca010de46f9139ce00
sha512=99a5afa3604c4cf0c849c670111d617f7f255acb0da043b73ddffdf0e299948bce52516ee31921f269de6088156c4e0a187e0b931543c6819c6b25966b303281

doc/batteries.unthreaded/BatIO/BigEndian/index.html

Module BatIO.BigEndianSource

Same operations as module BatIO, but with big-endian encoding

This module redefines the operations of module BatIO which behave differently on big-endian inputs/outputs.

Generally, to use this module you will wish to either open both BatIO and BigEndian, so as to import a big-endian version of BatIO, as per open System.BatIO, BigEndian in ..., or to redefine locally BatIO to use big-endian encodings module BatIO = System.BatIO include BigEndian

Sourceval read_ui16 : input -> int

Read an unsigned 16-bit word.

Sourceval read_i16 : input -> int

Read a signed 16-bit word.

Sourceval read_i32 : input -> int

Read a signed 32-bit integer.

  • raises Overflow

    if the read integer cannot be represented as an OCaml 31-bit integer.

Sourceval read_real_i32 : input -> int32

Read a signed 32-bit integer as an OCaml int32.

Sourceval read_i64 : input -> int64

Read a signed 64-bit integer as an OCaml int64.

Sourceval read_double : input -> float

Read an IEEE double precision floating point value.

Sourceval read_float : input -> float

Read an IEEE single precision floating point value.

Sourceval write_ui16 : (int, _) printer

Write an unsigned 16-bit word.

Sourceval write_i16 : (int, _) printer

Write a signed 16-bit word.

Sourceval write_i32 : (int, _) printer

Write a signed 32-bit integer.

Sourceval write_real_i32 : (int32, _) printer

Write an OCaml int32.

Sourceval write_i64 : (int64, _) printer

Write an OCaml int64.

Sourceval write_double : (float, _) printer

Write an IEEE double precision floating point value.

Sourceval write_float : (float, _) printer

Write an IEEE single precision floating point value.

Sourceval ui16s_of : input -> int BatEnum.t

Read an enumeration of unsigned 16-bit words.

Sourceval i16s_of : input -> int BatEnum.t

Read an enumartion of signed 16-bit words.

Sourceval i32s_of : input -> int BatEnum.t

Read an enumeration of signed 32-bit integers.

  • raises Overflow

    if the read integer cannot be represented as an OCaml 31-bit integer.

Sourceval real_i32s_of : input -> int32 BatEnum.t

Read an enumeration of signed 32-bit integers as OCaml int32s.

Sourceval i64s_of : input -> int64 BatEnum.t

Read an enumeration of signed 64-bit integers as OCaml int64s.

Sourceval doubles_of : input -> float BatEnum.t

Read an enumeration of IEEE double precision floating point values.

Sourceval floats_of : input -> float BatEnum.t

Read an enumeration of IEEE single precision floating point values.