awint_ext 0.9.0

Externally allocating `awint` functionality
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

//! Externally allocated arbitrary width integers
//!
//! This crate contains another storage type called `ExtAwi` to go along with
//! `InlAwi` in the `awint_core` crate. This crate is separate because it
//! requires support for `alloc`. Also includes `FP` because it practically
//! requires allocation to use. This crate is intended to be used through the
//! main `awint` crate, available with the "alloc" feature.

#![cfg_attr(feature = "const_support", feature(const_mut_refs))]
#![no_std]
// We need to be certain in some places that lifetimes are being elided correctly
#![allow(clippy::needless_lifetimes)]
// There are many guaranteed nonzero lengths
#![allow(clippy::len_without_is_empty)]
// We are using special indexing everywhere
#![allow(clippy::needless_range_loop)]
// not const and tends to be longer
#![allow(clippy::manual_range_contains)]
// we need certain hot loops to stay separate
#![allow(clippy::branches_sharing_code)]
#![deny(unsafe_op_in_unsafe_fn)]

extern crate alloc;

mod extawi;
mod fp_core;
mod fp_ieee;
mod fp_logic;
#[cfg(feature = "serde_support")]
mod serde;
mod strings;

#[doc(hidden)]
pub use awint_core;
#[doc(hidden)]
pub use awint_core::awint_internals;
pub use awint_core::{bw, Bits, InlAwi, SerdeError};
pub use extawi::ExtAwi;
pub use fp_core::{FPType, FP};

/// Subset of `awint::awi`
pub mod awi {
    pub use awint_core::awi::*;
    pub use Option::{None, Some};
    pub use Result::{Err, Ok};

    pub use crate::{ExtAwi, FPType, FP};
}

/// Fixed point related items
pub mod fp {
    pub use super::fp_ieee::{F32, F64};
    pub use crate::{FPType, FP};
}