Bump version to 0.6.5 for new less-code-size feature
[dnssec-prover] / src / lib.rs
index 77c3cd94695e0a2d76f78aeb263a5567e7cb8554..f08034f687b1bdba1f43d34f30a1e2667a335f41 100644 (file)
@@ -15,7 +15,7 @@
 //! conservative MSRV policy, allowing it to be used in as many places as possible.
 //!
 //! Most of the crate's logic is feature-gated, and *all dependencies are optional*:
 //! conservative MSRV policy, allowing it to be used in as many places as possible.
 //!
 //! Most of the crate's logic is feature-gated, and *all dependencies are optional*:
-//!  * By default, the `validate` feature is set, using `ring` to validate DNSSEC signatures and
+//!  * By default, the `validation` feature is set, allowing to validate DNSSEC signatures and
 //!    proofs using the [`validation`] module.
 //!  * The `std` feature enables the [`query`] module, allowing for the building of proofs by
 //!    querying a recursive resolver over TCP.
 //!    proofs using the [`validation`] module.
 //!  * The `std` feature enables the [`query`] module, allowing for the building of proofs by
 //!    querying a recursive resolver over TCP.
 //!    queries over HTTP GET calls to `/dnssecproof?d=domain.name.&t=RecordType` with DNSSEC
 //!    proofs.
 //!
 //!    queries over HTTP GET calls to `/dnssecproof?d=domain.name.&t=RecordType` with DNSSEC
 //!    proofs.
 //!
-//! Note that this library's MSRV is 1.64 for normal building, however builds fine on 1.63 (and
-//! possibly earlier) when `RUSTC_BOOTSTRAP=1` is set, as it relies on the
-//! `const_slice_from_raw_parts` feature.
+//! The `slower_smaller_binary` feature slows proof validation down by 50%+ for a very marginal
+//! reduction in binary size, but those who are extremely binary size constrained may still find it
+//! useful.
 
 #![deny(missing_docs)]
 #![deny(rustdoc::broken_intra_doc_links)]
 #![deny(rustdoc::private_intra_doc_links)]
 
 
 #![deny(missing_docs)]
 #![deny(rustdoc::broken_intra_doc_links)]
 #![deny(rustdoc::private_intra_doc_links)]
 
-// const_slice_from_raw_parts was stabilized in 1.64, however we support building on 1.63 as well.
-// Luckily, it seems to work fine in 1.63 with the feature flag (and RUSTC_BOOTSTRAP=1) enabled.
-#![cfg_attr(rust_1_63, feature(const_slice_from_raw_parts))]
+#![allow(clippy::new_without_default)] // why is this even a lint
+#![allow(clippy::result_unit_err)] // Why in the hell is this a lint?
+#![allow(clippy::get_first)] // Sometimes this improves readability
+#![allow(clippy::needless_lifetimes)] // lifetimes improve readability
+#![allow(clippy::needless_borrow)] // borrows indicate read-only/non-move
+#![allow(clippy::too_many_arguments)] // sometimes we don't have an option
+#![allow(clippy::identity_op)] // sometimes identities improve readability for repeated actions
+#![allow(clippy::erasing_op)] // sometimes identities improve readability for repeated actions
 
 #![cfg_attr(not(feature = "std"), no_std)]
 extern crate alloc;
 
 
 #![cfg_attr(not(feature = "std"), no_std)]
 extern crate alloc;
 
+/// The maximum number of requests we will make when building a proof or the maximum number of
+/// [`rr::RRSig`] sets we'll validate records from when validating proofs.
+// Note that this is duplicated exactly in src/http.rs
+pub const MAX_PROOF_STEPS: usize = 20;
+
 #[cfg(feature = "validation")]
 mod base32;
 
 #[cfg(feature = "validation")]
 mod base32;