zkp_u256/
lib.rs

1// This sequence needs to be repeated in each project as a workaround.
2//       See https://github.com/rust-lang/cargo/issues/5034
3// For clippy lints see: https://rust-lang.github.io/rust-clippy/master
4// For rustc lints see: https://doc.rust-lang.org/rustc/lints/index.html
5#![cfg_attr(not(feature = "std"), no_std)]
6#![forbid(unsafe_code)]
7#![warn(
8    // Enable sets of warnings
9    clippy::all,
10    clippy::pedantic,
11    clippy::cargo,
12    rust_2018_idioms,
13    future_incompatible,
14    unused,
15
16    // Additional unused warnings (not included in `unused`)
17    unused_lifetimes,
18    unused_qualifications,
19    unused_results,
20
21    // Additional misc. warnings
22    anonymous_parameters,
23    deprecated_in_future,
24    elided_lifetimes_in_paths,
25    explicit_outlives_requirements,
26    keyword_idents,
27    macro_use_extern_crate,
28    // missing_docs,
29    missing_doc_code_examples,
30    private_doc_tests,
31    single_use_lifetimes,
32    trivial_casts,
33    trivial_numeric_casts,
34    unreachable_pub,
35    unsafe_code,
36    variant_size_differences
37)]
38#![cfg_attr(feature = "std", warn(missing_debug_implementations,))]
39// rand_xoshiro v0.4.0 is required for a zkp-stark example and v0.3.1 for criterion
40#![allow(clippy::multiple_crate_versions)]
41// TODO: Add `must_use` where relevant
42#![allow(clippy::must_use_candidate)]
43// All `#[inline(always)]` attributes are carefully considered and benchmarked.
44// Performance is an important goal of this library.
45// TODO: Provide two versions of hot functions `_inlined` and plain.
46#![allow(clippy::inline_always)]
47// TODO: Document errors
48#![allow(clippy::missing_errors_doc)]
49// Some routines have assembly optimized versions available for some
50// architectures
51// TODO: No asm on stable
52// See <https://github.com/rust-lang/rust/issues/29722>
53#![cfg_attr(all(feature = "asm", not(feature = "stable")), feature(asm))]
54// TODO: Port over to new asm syntax.
55#![cfg_attr(all(feature = "asm", not(feature = "stable")), feature(llvm_asm))]
56
57mod additive;
58pub(crate) mod algorithms;
59mod arch;
60mod binary;
61mod conversion;
62mod division;
63mod encoding;
64mod functions;
65mod multiplicative;
66#[cfg(feature = "rand")]
67mod rand;
68mod traits;
69mod u256;
70mod u256_traits;
71
72// TODO: Create a BinaryRing trait that represents numbers modulo some power of
73// two.
74
75pub use u256::U256;
76
77pub use algorithms::{adc, div_2_1, mac, msb, sbb, to_montgomery_const};
78// pub use arch::{divrem_nby1, divrem_nbym};
79pub use num_traits::{Bounded, Inv, MulAdd, MulAddAssign, One, Pow, Zero};
80pub use traits::{
81    AddFullInline, AddInline, Binary, BinaryAssignRef, BinaryOps, BinaryRing, DivRem, InvMod,
82    Montgomery, MontgomeryParameters, MulFullInline, MulInline, NegInline, SquareFullInline,
83    SquareInline, SubFromFullInline, SubFromInline, SubFullInline, SubInline, GCD,
84};
85
86#[cfg(not(feature = "std"))]
87extern crate no_std_compat as std;
zkp_u256/lib.rs

zkp_u256/
lib.rs
