milksad
/
rust-bitcoin-unsafe-fast
14
0
Fork 0
Code Issues Pull Requests Activity
rust-bitcoin-unsafe-fast/internals/src/lib.rs

33 lines
757 B
Rust
Raw Normal View History

Introduce bitcoin-internals crate Add a new crate `bitcoin-internals` to be used for internal code needed by multiple soon-to-be-created crates. Add the `write_err` macro to `bitcoin-internals`, nothing else. This patch uses a `path` dependency which means `rust-bitcoin` cannot be released in its current state, will need to be changed once we release the `bitcoin-internals` crate on `crates.io`.
2022-09-05 02:19:28 +00:00
// SPDX-License-Identifier: CC0-1.0
//! # Rust Bitcoin Internal
//!
//! This crate is only meant to be used internally by crates in the
//! [rust-bitcoin](https://github.com/rust-bitcoin) ecosystem.
//!
Implement basic support for fast hex encoding There's a `hex` module in `bitcoin_hashes` which is a bit out of place and not very fast - it passes each *digit* through dynamic dispatch not only adding overhead but also not allowing `String` to make better allocations. This change adds basic support for hex encoding using a stack-allocated buffer which minimizes the overhead of dynamic dispatch. It also provides a new `DisplayHex` trait designed to replace `ToHex` found in `bitcoin_hashes`.
2022-09-13 19:08:34 +00:00
#![no_std]
Make crate level attributes uniform Make the trait level attributes uniform across all released crates in the repo. Excludes things that are obviously not needed, eg, bench stuff if there is not bench code. - Remove `uninhabited_references` - this is allow by default now. - Remove `unconditional_recursion` and mark the single false positive we have with an `allow`. Note, this does not add `missing_docs` to the `io` crate. There is an open PR at the moment to add that along with the required docs.
2024-01-25 06:41:01 +00:00
Introduce bitcoin-internals crate Add a new crate `bitcoin-internals` to be used for internal code needed by multiple soon-to-be-created crates. Add the `write_err` macro to `bitcoin-internals`, nothing else. This patch uses a `path` dependency which means `rust-bitcoin` cannot be released in its current state, will need to be changed once we release the `bitcoin-internals` crate on `crates.io`.
2022-09-05 02:19:28 +00:00
// Experimental features we need.
Use doc_auto_cfg If we use `#![cfg_attr(docsrs, feature(doc_auto_cfg))]` instead of `#![cfg_attr(docsrs, feature(doc_cfg))]` we no longer need to manually mark types with `#[cfg_attr(docsrs, doc(cfg(feature = "std")))]`. Sweeeeeet.
2023-03-29 03:40:23 +00:00
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
Make crate level attributes uniform Make the trait level attributes uniform across all released crates in the repo. Excludes things that are obviously not needed, eg, bench stuff if there is not bench code. - Remove `uninhabited_references` - this is allow by default now. - Remove `unconditional_recursion` and mark the single false positive we have with an `allow`. Note, this does not add `missing_docs` to the `io` crate. There is an open PR at the moment to add that along with the required docs.
2024-01-25 06:41:01 +00:00
// Coding conventions.
Move deny lint checks to script Signed-off-by: Harshil Jani <harshiljani2002@gmail.com>
2023-02-10 19:01:42 +00:00
#![warn(missing_docs)]
Make crate level attributes uniform Make the trait level attributes uniform across all released crates in the repo. Excludes things that are obviously not needed, eg, bench stuff if there is not bench code. - Remove `uninhabited_references` - this is allow by default now. - Remove `unconditional_recursion` and mark the single false positive we have with an `allow`. Note, this does not add `missing_docs` to the `io` crate. There is an open PR at the moment to add that along with the required docs.
2024-01-25 06:41:01 +00:00
// Exclude lints we don't think are valuable.
Add clippy exceptions for needless_question_mark lint
2023-10-20 14:58:42 +00:00
#![allow(clippy::needless_question_mark)] // https://github.com/rust-bitcoin/rust-bitcoin/pull/2134
Make crate level attributes uniform Make the trait level attributes uniform across all released crates in the repo. Excludes things that are obviously not needed, eg, bench stuff if there is not bench code. - Remove `uninhabited_references` - this is allow by default now. - Remove `unconditional_recursion` and mark the single false positive we have with an `allow`. Note, this does not add `missing_docs` to the `io` crate. There is an open PR at the moment to add that along with the required docs.
2024-01-25 06:41:01 +00:00
#![allow(clippy::manual_range_contains)] // More readable than clippy's format.
Introduce bitcoin-internals crate Add a new crate `bitcoin-internals` to be used for internal code needed by multiple soon-to-be-created crates. Add the `write_err` macro to `bitcoin-internals`, nothing else. This patch uses a `path` dependency which means `rust-bitcoin` cannot be released in its current state, will need to be changed once we release the `bitcoin-internals` crate on `crates.io`.
2022-09-05 02:19:28 +00:00
Implement basic support for fast hex encoding There's a `hex` module in `bitcoin_hashes` which is a bit out of place and not very fast - it passes each *digit* through dynamic dispatch not only adding overhead but also not allowing `String` to make better allocations. This change adds basic support for hex encoding using a stack-allocated buffer which minimizes the overhead of dynamic dispatch. It also provides a new `DisplayHex` trait designed to replace `ToHex` found in `bitcoin_hashes`.
2022-09-13 19:08:34 +00:00
#[cfg(feature = "alloc")]
extern crate alloc;
#[cfg(feature = "std")]
extern crate std;
Add a simple `Copy`-able `ArrayVec` The `arrayvec::ArrayVec` type is not `Copy` which is not nice and we would like to have a `Copy` type in our crates. While the PR to add support to the `arrayvec` crate is not merged we implement our own simplified version. This one acts mostly as a dumb storage - it has just a few methods and traits. The new ones can be added as needed later.
2023-12-14 16:25:46 +00:00
pub mod array_vec;
Add tools that help with making code `const` There are various challenges when making code `const`: making it conditional, awkward copying of slices... This change adds tools that help dealing with these challenges.
2023-12-14 16:21:37 +00:00
pub mod const_tools;
Introduce bitcoin-internals crate Add a new crate `bitcoin-internals` to be used for internal code needed by multiple soon-to-be-created crates. Add the `write_err` macro to `bitcoin-internals`, nothing else. This patch uses a `path` dependency which means `rust-bitcoin` cannot be released in its current state, will need to be changed once we release the `bitcoin-internals` crate on `crates.io`.
2022-09-05 02:19:28 +00:00
pub mod error;
Move impl_array_newtype to bitcoin_internals `impl_array_newtype` is an internal macro, move it to a new, ever so meaningfully named, `macros` module. Use `#[macro_export]`, no other changes to the macro.
2022-09-20 04:39:20 +00:00
pub mod macros;
Implement support for `alloc`-free parse errors This implements basic facilities to conditionally carry string inputs in parse errors. This includes: * `InputString` type that may carry the input and format it * `parse_error_type!` macro creating a special type for parse errors * `impl_parse` implementing parsing for various types as well as its `serde`-supporting alternative
2022-09-20 15:11:35 +00:00
mod parse;
pub mod serde;