Skip to content

crypto-bigint v0.2.6 #617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 8, 2021
Merged

crypto-bigint v0.2.6 #617

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 10 additions & 0 deletions crypto-bigint/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## 0.2.6 (2021-09-08)
### Added
- `Integer` trait ([#612])
- `ShrAssign` impl for `UInt` ([#615])
- Recursive Length Prefix (RLP) encoding support for `UInt` ([#616])

[#612]: https://github.com/RustCrypto/utils/pull/612
[#615]: https://github.com/RustCrypto/utils/pull/615
[#616]: https://github.com/RustCrypto/utils/pull/616

## 0.2.5 (2021-09-02)
### Fixed
- `ConditionallySelectable` impl for `UInt` ([#609])
Expand Down
2 changes: 1 addition & 1 deletion crypto-bigint/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "crypto-bigint"
version = "0.2.5" # Also update html_root_url in lib.rs when bumping this
version = "0.2.6" # Also update html_root_url in lib.rs when bumping this
description = """
Pure Rust implementation of a big integer library which has been designed from
the ground-up for use in cryptographic applications. Provides constant-time,
Expand Down
7 changes: 1 addition & 6 deletions crypto-bigint/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,14 @@
//!
//! Please see the [feature wishlist tracking ticket] for more information.
//!
//! # `generic-array` interop
//! When the optional `generic-array` feature is enabled, this library provides
//! an [`ArrayEncoding`] trait which can be used to serialize/deserialize big
//! integer values as `GenericArray<u8, N>`.
//!
//! [feature wishlist tracking ticket]: https://github.com/RustCrypto/utils/issues/453

#![no_std]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![doc(
html_logo_url = "https://raw.githubusercontent.com/RustCrypto/meta/master/logo.svg",
html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/meta/master/logo.svg",
html_root_url = "https://docs.rs/crypto-bigint/0.2.5"
html_root_url = "https://docs.rs/crypto-bigint/0.2.6"
)]
#![forbid(unsafe_code, clippy::unwrap_used)]
#![warn(missing_docs, rust_2018_idioms, unused_qualifications)]
Expand Down
8 changes: 6 additions & 2 deletions crypto-bigint/src/uint.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,12 @@ use zeroize::DefaultIsZeroes;
/// [`Encoding`][`crate::Encoding`] trait or various `const fn` decoding and
/// encoding functions that can be used with [`UInt`] constants.
///
/// Support for Recursive Length Prefix (RLP) encoding is available under the
/// optional `rlp` crate feature.
/// Optional crate features for encoding (off-by-default):
/// - `generic-array`: enables [`ArrayEncoding`][`crate::ArrayEncoding`] trait which can be used to
/// [`UInt`] as `GenericArray<u8, N>`.
/// - `rlp`: support for [Recursive Length Prefix (RLP)][RLP] encoding.
///
/// [RLP]: https://eth.wiki/fundamentals/rlp
// TODO(tarcieri): make generic around a specified number of bits.
#[derive(Copy, Clone, Debug, Hash)]
pub struct UInt<const LIMBS: usize> {
Expand Down