package containers

You can search for identifiers within the package.

in-package search v0.2.0

A modular, clean and powerful extension of the OCaml standard library

Install

Dune Dependency

github.com Readme Changelog Edit opam file Versions (23)

Authors

S

Simon Cruanes

Maintainers

S

simon.cruanes.2007@m4x.org

Sources

v3.6.1.tar.gz

md5=efbef89f1e3460225c7d03e3ae2af62e

sha512=e3b43af275a660c46e7ded32c1a6e51396589a25af7b64187d044bcbfd05f5143f9024c4655921c606b86b99d0ab73e81c99dc75b23d52601682491c1b6abc9f

doc/containers.codegen/Containers_codegen/Bitfield/index.html

Module `Containers_codegen.Bitfield`Source

Generate efficient bitfields that fit in an integer

Sourcetype t

Sourceval make : ?emit_failure_if_too_wide:bool -> name:string -> unit -> t

Make a new bitfield with the given name.

parameter name
the name of the generated type

parameter emit_failure_if_too_wide
if true, generated code includes a runtime assertion that Sys.int_size is wide enough to support this type

Sourceval field_bit : t -> string -> unit

field_bit ty name adds a field of size 1 to the bitfield ty, with name name. The generate code will provide get/set for a boolean.

Sourceval field_int : t -> width:int -> string -> unit

field_int ty name ~width adds a field of size width to the bitfield with name name. The accessors will be for integers of width bits, and the setter might assert that the provided integer fits.

Sourceval total_width : t -> int

Total width in bits of the given bitfield.

Sourceval gen_mli : t -> code

Generate code for the type signature for the given bitfield

Sourceval gen_ml : t -> code

Generate code for the implementation for the given bitfield

On This Page

Generate efficient bitfields that fit in an integer