Merge pull request #150 from bobmcwhirter/rng-trait

Add an RNG trait.

2 files changed, 18 insertions, 0 deletions

diff --git a/embassy-traits/src/lib.rs b/embassy-traits/src/lib.rs
index ea59444c1..1ce5dbe7e 100644
--- a/embassy-traits/src/lib.rs
+++ b/embassy-traits/src/lib.rs
@@ -14,3 +14,4 @@ pub mod gpio;
 pub mod i2c;
 pub mod spi;
 pub mod uart;
+pub mod rng;
diff --git a/embassy-traits/src/rng.rs b/embassy-traits/src/rng.rs
new file mode 100644
index 000000000..af786bd4a
--- /dev/null
+++ b/embassy-traits/src/rng.rs
@@ -0,0 +1,17 @@
+use core::future::Future;
+
+/// Random-number Generator
+pub trait Rng {
+    type Error;
+
+    type RngFuture<'a>: Future<Output = Result<(), Self::Error>> + 'a
+    where
+        Self: 'a;
+
+    /// Completely fill the provided buffer with random bytes.
+    ///
+    /// May result in delays if entropy is exhausted prior to completely
+    /// filling the buffer. Upon completion, the buffer will be completely
+    /// filled or an error will have been reported.
+    fn fill<'a>(&'a mut self, dest: &'a mut [u8]) -> Self::RngFuture<'a>;
+}