package bitstring

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

Install 

dune-project
 Dependency

bitstring.software Readme Edit opam file Versions (9)

Authors

  1. R
    Richard W.M. Jones
  2. X
    Xavier R. Guérin

Maintainers

  1. X
    Xavier R. Guérin <ghub@applepine.org>

Sources

bitstring.3.1.1.tar.gz
sha256=867299a702784ca8ac59bb50dcf4c2cdec49fba2c4ed89f8de40c60ac671b22f
md5=ebf52fe55946c70aa7cb3fe51905b830

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: 06 Dec 2019

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

Appreciation

Tokens of appreciation are gladly accepted in the form of virtual coffee.

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 (5)

  1. stdlib-shims
  2. ocaml-migrate-parsetree >= "1.0.5" & < "2.0.0"
  3. ppx_tools_versioned build
  4. dune
  5. ocaml >= "4.02.3"

Dev Dependencies (1)

  1. ounit with-test

Conflicts (1)

  1. ppx_bitstring