package bitstring

  1. Overview
  2. Docs
bitstrings and bitstring matching for OCaml

Install

Dune Dependency

Authors

Maintainers

Sources

bitstring.3.0.0.tar.gz
sha256=ee066207521c925e1f24467dc33f0af8fb2f7623ec149fff927df5b45723d8e4
md5=ce1d3b99ed9d4ff98af1fafd9274d897

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.

Published: 12 Jan 2018

README

OCaml Bistring 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

How to use

Ocamlfind

ocamlfind c -package bitstring -package bitstring.ppx -linkpkg ...

Jbuilder

(jbuild_version 1)

(executable
 ((name        foo)
  (libraries   (bitstring))
  (preprocess  (pps (bitstring.ppx)))
  ))

How to build

bitstring version 3 requires OCaml >= 4.02.3.

Dependencies

  • str
  • unix
  • compiler-libs
  • ppx_tools_versioned
  • ocaml-migrate-parsetree

Building the project

$ jbuilder build

Running the tests

$ jbuilder 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 (4)

  1. ocaml-migrate-parsetree >= "1.0.5" & < "2.0.0"
  2. ppx_tools_versioned
  3. jbuilder >= "1.0+beta7"
  4. ocaml >= "4.02.3"

Dev Dependencies (1)

  1. ounit with-test

Conflicts (1)

  1. ppx_bitstring
OCaml

Innovation. Community. Security.