package hardcaml

  1. Overview
  2. Docs
package hardcaml
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Make_interface_with_conversion.Of_bitsSource

Sourcetype comb = Bits.t
Sourcetype t = comb t
Sourceval sexp_of_t : comb t -> Sexplib0.Sexp.t
Sourceval assert_widths : comb t -> Base.unit

Raise if the widths of t do not match those specified in the interface.

Sourceval of_int : Base.int -> comb t

Each field is set to the constant integer value provided.

Sourceval const : Base.int -> comb t
  • deprecated [since 2019-11] interface const
Sourceval pack : ?rev:Base.bool -> comb t -> comb

Pack interface into a vector.

Sourceval unpack : ?rev:Base.bool -> comb -> comb t

Unpack interface from a vector.

Sourceval mux : comb -> comb t Base.list -> comb t

Multiplex a list of interfaces.

Sourceval mux2 : comb -> comb t -> comb t -> comb t
Sourceval concat : comb t Base.list -> comb t

Concatenate a list of interfaces.

Sourceval priority_select_with_default : ((comb, comb t) Comb.with_valid2 Base.list -> default:comb t -> comb t) Comb.optional_branching_factor
Sourceval widths : t -> Base.int t

Actual bit widths of each field.

Sourceval of_ints : Base.int t -> t

consts c sets each field to the integer value in c using the declared field bit width.

Sourceval consts : Base.int t -> t
  • deprecated [since 2019-11] interface consts
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct