Skip to content

add adapters for digest trait #678

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.

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

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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: 2 additions & 0 deletions embedded-io-adapters/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ categories = [
]

[features]
default = ["digest"]
Copy link
Author

@master-hax master-hax Aug 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be fine to enable by default since digest is also no_std without the default features

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'd prefer to make it optional to not bloat up people's dependency trees and also because the 0.10 vs 0.11 thing

std = ["embedded-io/std"]
tokio-1 = ["std", "dep:tokio", "dep:embedded-io-async", "embedded-io-async?/std"]
futures-03 = ["std", "dep:futures", "dep:embedded-io-async", "embedded-io-async?/std"]

[dependencies]
digest = { version = "0.10.7", default-features = false, optional = true }
embedded-io = { version = "0.6", path = "../embedded-io" }
embedded-io-async = { version = "0.6.1", path = "../embedded-io-async", optional = true }

Expand Down
108 changes: 108 additions & 0 deletions embedded-io-adapters/src/digest.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
//! Adapters to/from `digest::Digest` traits e.g. sha2::Sha256

use core::convert::Infallible;
use digest::Update;
use embedded_io::{ErrorType, Write};

/// Adapter from `digest::Digest` traits.
#[derive(Clone)]
pub struct FromDigest<T: ?Sized> {
inner: T,
}

impl<T> FromDigest<T> {
/// Create a new adapter.
pub fn new(inner: T) -> Self {
Self { inner }
}

/// Consume the adapter, returning the inner object.
pub fn into_inner(self) -> T {
self.inner
}
}

impl<T: ?Sized> FromDigest<T> {
/// Borrow the inner object.
pub fn inner(&self) -> &T {
&self.inner
}

/// Mutably borrow the inner object.
pub fn inner_mut(&mut self) -> &mut T {
&mut self.inner
}
}

impl<T> ErrorType for FromDigest<T> {
type Error = Infallible;
}

impl<T: Update> Write for FromDigest<T> {
fn write(&mut self, data: &[u8]) -> Result<usize, <Self as ErrorType>::Error> {
T::update(&mut self.inner, data);
Ok(data.len())
}
fn flush(&mut self) -> Result<(), <Self as ErrorType>::Error> {
Ok(())
}
}

impl<T: Default> Default for FromDigest<T> {
fn default() -> Self {
Self {
inner: T::default(),
}
}
}

/// Adapter to `digest::Digest` traits.
#[derive(Clone)]
pub struct ToDigest<T: ?Sized> {
inner: T,
}

impl<T> ToDigest<T> {
/// Create a new adapter.
pub fn new(inner: T) -> Self {
Self { inner }
}

/// Consume the adapter, returning the inner object.
pub fn into_inner(self) -> T {
self.inner
}
}

impl<T: ?Sized> ToDigest<T> {
/// Borrow the inner object.
pub fn inner(&self) -> &T {
&self.inner
}

/// Mutably borrow the inner object.
pub fn inner_mut(&mut self) -> &mut T {
&mut self.inner
}
}

impl<T: Default> Default for ToDigest<T> {
fn default() -> Self {
Self {
inner: T::default(),
}
}
}

impl<T: ErrorType<Error = Infallible> + Write> Update for ToDigest<T> {
fn update(&mut self, data: &[u8]) {
match self.inner.write_all(data) {
Ok(()) => {}
Err(_) => unreachable!(),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's better to do Err(e) => match e{} so the compiler checks for you that it's actually unreachable.

}
match self.inner.flush() {
Ok(()) => {}
Err(_) => unreachable!(),
}
}
}
4 changes: 4 additions & 0 deletions embedded-io-adapters/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,7 @@ pub mod futures_03;
#[cfg(feature = "tokio-1")]
#[cfg_attr(docsrs, doc(cfg(feature = "tokio-1")))]
pub mod tokio_1;

#[cfg(feature = "digest")]
#[cfg_attr(docsrs, doc(cfg(feature = "digest")))]
pub mod digest;