Crate awint

Expand description

This crate compiles all the interfaces of awint_core, awint_macros, and awint_ext (when the default “alloc” feature is enabled). Enabling the “dag” feature flag also enables the dag module and a reexport of awint_dag. There are also hidden developer reexports.

Modules§

awi: Reexports all the regular arbitrary width integer structs, macros, common enums, and most of core::primitive::*.
fp: Fixed point related items
macro_docs: Macro documentation
prelude: Reexports items defined within the awint crate system

Macros§

awi: A concatenations of components macro, additionally using the source value to construct an Awi. See awint::macro_docs for more.
bits: A concatenations of components macro, additionally using the source value to construct a &'static Bits.
cc: Copy Corresponding Concatenations of Components Dynamically.
extawi: A concatenations of components macro, additionally using the source value to construct an ExtAwi. See awint::macro_docs for more.
inlawi: A concatenations of components macro, additionally using the source value to construct an InlAwi. See awint::macro_docs for more.
inlawi_ty: Specifies an InlAwi type in terms of its bitwidth

Structs§

Awi: An arbitrary width integer with manually controlled bitwidth.
Bits: A reference to the bits in an InlAwi, ExtAwi, Awi, or other backing construct.
ExtAwi: An arbitrary width integer with manually controlled bitwidth. Most arithmetic is wrapping like Rust’s integers. All reallocations are explicit.
FP: Fixed-Point generic struct for B that implement Borrow<Bits> and BorrowMut<Bits>. Adds on signedness and fixed-point information. Implements many traits if B also implements them.
FPType: Fixed-Point Type, containing signedness, bitwidth, and fixed point
InlAwi: An arbitrary width integer with const generic bitwidth that can be stored inline on the stack like an array.
OrdBits: A wrapper implementing total ordering

Enums§

SerdeError: A serialization or deserialization error

Functions§