hashes: Move errors in sha256 to error submodule
What the developer wrote
Authored by Mitchell Bagot
hashes: Move errors in sha256 to error submodule
As with the other crates, errors in hashes should be moved to
submodules for each of the top-level modules. Any errors should then
be no_inline re-exported in the top-level module.
Move MidstateError to new error submodule and re-export in sha256.
What changed, and why it matters
This commit is a routine code reorganization. It moves the definition of an error type called MidstateError into a new 'error' submodule within the SHA256 code, then re-exports it at the original location so existing users are unaffected. There is no functional change to how the code behaves.
No security action needed; this is a non-functional refactor.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The patch refactors hashes/src/sha256/mod.rs by creating a new pub mod error and moving MidstateError, its Display impl, and its std::error::Error impl into it. The top-level module adds a #[doc(no_inline)] pub use self::error::MidstateError to preserve the public API path. Field visibility is narrowed from private (default) to pub(super), which is equivalent in effect because the fields were already private. No logic, bounds checks, or behavior changed.
Changed components
hashes/src/sha256/mod.rsInspect captured patch +39 / −26
diff --git a/hashes/src/sha256/mod.rs b/hashes/src/sha256/mod.rs
index 7d29fb1d..57d7a001 100644
--- a/hashes/src/sha256/mod.rs
+++ b/hashes/src/sha256/mod.rs
@@ -16,6 +16,10 @@ use crate::{incomplete_block_len, sha256d};
#[cfg(doc)]
use crate::{sha256t, sha256t_tag};
+#[rustfmt::skip] // Keep public re-exports separate.
+#[doc(no_inline)]
+pub use self::error::MidstateError;
+
crate::internal_macros::general_hash_type! {
/// Output of the SHA256 hash function.
pub struct Hash([u8; 32]);
@@ -261,35 +265,44 @@ impl convert::AsRef<[u8]> for Midstate {
fn as_ref(&self) -> &[u8] { &self.bytes }
}
-/// [`Midstate`] invariant violated (not a multiple of 64).
-#[derive(Debug, Clone, PartialEq, Eq)]
-pub struct MidstateError {
- /// The invalid number of bytes hashed.
- invalid_n_bytes_hashed: u64,
- block_aligned_midstate: Midstate,
- unprocessed_bytes: [u8; BLOCK_SIZE],
- unprocessed_bytes_len: usize,
-}
+/// Error types for the SHA256 hash
+pub mod error {
+ use core::fmt;
-impl MidstateError {
- /// Returns block-aligned midstate
- pub const fn midstate(&self) -> &Midstate { &self.block_aligned_midstate }
+ use super::{Midstate, BLOCK_SIZE};
- /// returns the unprocessed bytes remaining in the buffer.
- pub fn unprocessed_bytes(&self) -> &[u8] {
- &self.unprocessed_bytes[..self.unprocessed_bytes_len]
+ /// [`Midstate`] invariant violated (not a multiple of 64).
+ ///
+ /// [`Midstate`]: super::Midstate
+ #[derive(Debug, Clone, PartialEq, Eq)]
+ pub struct MidstateError {
+ /// The invalid number of bytes hashed.
+ pub(super) invalid_n_bytes_hashed: u64,
+ pub(super) block_aligned_midstate: Midstate,
+ pub(super) unprocessed_bytes: [u8; BLOCK_SIZE],
+ pub(super) unprocessed_bytes_len: usize,
}
-}
-impl fmt::Display for MidstateError {
- fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
- write!(
- f,
- "invalid number of bytes hashed {} (should have been a multiple of 64)",
- self.invalid_n_bytes_hashed
- )
+ impl MidstateError {
+ /// Returns block-aligned midstate
+ pub const fn midstate(&self) -> &Midstate { &self.block_aligned_midstate }
+
+ /// returns the unprocessed bytes remaining in the buffer.
+ pub fn unprocessed_bytes(&self) -> &[u8] {
+ &self.unprocessed_bytes[..self.unprocessed_bytes_len]
+ }
+ }
+
+ impl fmt::Display for MidstateError {
+ fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+ write!(
+ f,
+ "invalid number of bytes hashed {} (should have been a multiple of 64)",
+ self.invalid_n_bytes_hashed
+ )
+ }
}
-}
-#[cfg(feature = "std")]
-impl std::error::Error for MidstateError {}
+ #[cfg(feature = "std")]
+ impl std::error::Error for MidstateError {}
+}
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.