package batteries

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

Install 

dune-project
 Dependency

github.com 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>

Sources

v3.5.0.tar.gz
md5=e4b70d1a716f0aaba36f419f618d0a2e
sha512=a31f1f8cf2c7c3c6c757f3bfae98ff61bb32bab6a1f1e215937df42bcfa447aad41a37edb28d7bcecb88b3838ed8bd57142bcf8e2d28e09bb538055fd8a3b72d

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

Module BatIO.BigEndian

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

val read_ui16 : input -> int

Read an unsigned 16-bit word.

val read_i16 : input -> int

Read a signed 16-bit word.

val 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.

val read_real_i32 : input -> int32

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

val read_i64 : input -> int64

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

val read_double : input -> float

Read an IEEE double precision floating point value.

val read_float : input -> float

Read an IEEE single precision floating point value.

val write_ui16 : (int, _) printer

Write an unsigned 16-bit word.

val write_i16 : (int, _) printer

Write a signed 16-bit word.

val write_i32 : (int, _) printer

Write a signed 32-bit integer.

val write_real_i32 : (int32, _) printer

Write an OCaml int32.

val write_i64 : (int64, _) printer

Write an OCaml int64.

val write_double : (float, _) printer

Write an IEEE double precision floating point value.

val write_float : (float, _) printer

Write an IEEE single precision floating point value.

val ui16s_of : input -> int BatEnum.t

Read an enumeration of unsigned 16-bit words.

val i16s_of : input -> int BatEnum.t

Read an enumartion of signed 16-bit words.

val 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.

val real_i32s_of : input -> int32 BatEnum.t

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

val i64s_of : input -> int64 BatEnum.t

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

val doubles_of : input -> float BatEnum.t

Read an enumeration of IEEE double precision floating point values.

val floats_of : input -> float BatEnum.t

Read an enumeration of IEEE single precision floating point values.