package bitstring

All checked builds pass
  1. Overview
  2. Docs
Bitstrings and bitstring matching for OCaml

Install

dune-project
 Dependency

Authors

Maintainers

Sources

v4.1.0.tar.gz
sha256=67f0cc4466be538abf2d1fdea8517c35de1e7df8ce5b96341964ce8aebf54298
md5=8ae6f04eaa29481c6830ee3be5cba755

Description

The ocaml-bitstring project adds Erlang-style bitstrings and matching over bitstrings as a syntax extension and library for OCaml. You can use this module to both parse and generate binary formats, files and protocols. Bitstring handling is added as primitives to the language, making it exceptionally simple to use and very powerful.

Added to opam-repository:

README

OCaml Bitstring Library

Build Status

Copyright (C) 2008-2016 Red Hat Inc, Richard W.M. Jones.
Copyright (C) 2016-2018 Red Hat Inc, Richard W.M. Jones, Xavier R. Guerin.

The original README content can be found in the README.orig file.

Documentation

The documentation is located here.

How to install

opam install bitstring
opam install ppx_bitstring

How to use

Ocamlfind

ocamlfind c -package bitstring -package ppx_bitstring -linkpkg ...

Dune

(executable
 ((name        foo)
  (libraries   (bitstring))
  (preprocess  (pps (ppx_bitstring)))
  ))

How to build

Dependencies

Required packages are detailed in the dune-project file.

Building the project

$ dune build

Running the tests

$ dune runtest

License

The library is licensed under the LGPL v2 or later, with the OCaml linking exception. See the file COPYING.LIB for full terms. Programs are licensed under the GPL v2 or later. See the file COPYING for full terms. All examples and tests are public domain.

Dependencies (3)

  1. stdlib-shims >= "0.1.0"
  2. ocaml >= "4.04.1"
  3. dune >= "2.5"

Dev Dependencies

None

Optional Dependencies

None

Conflicts

None

Build status

Results of building bitstring with each compiler on check.ci.ocaml.org, run of against opam-repository 78c202b. All results for this package.

Each result links to its build log. To keep crawlers from overloading the site, build logs require a GitHub sign-in (see ocurrent/opam-health-check). On your first log, GitHub asks you to “Authorize opam-health-check”, the OCurrent app that runs these checks; it sees only your public profile, not your repositories. The sign-in lasts 30 days.

Version OCaml 4.11 OCaml 4.14 OCaml 5.2 OCaml 5.4 OCaml 5.5
5.0.2 n/a n/a good good good
4.1.0 (this version) good good good good good
  • good Package successfully built
  • partial One of the dependencies failed to build
  • bad Package failed to build
  • n/a Package is not available in this environment
  • internal Internal failure