Trait kernel::hil::entropy::Entropy8

source ·
pub trait Entropy8<'a> {
    // Required methods
    fn get(&self) -> Result<(), ErrorCode>;
    fn cancel(&self) -> Result<(), ErrorCode>;
    fn set_client(&'a self, _: &'a dyn Client8);
}
Expand description

An 8-bit entropy generator.

Implementors should assume the client implements the Client8 trait.

Required Methods§

source

fn get(&self) -> Result<(), ErrorCode>

Initiate the acquisition of new entropy.

There are three valid return values:

  • Ok(()): a entropy_available callback will be called in the future when entropy is available.
  • FAIL: a entropy_available callback will not be called in the future, because entropy cannot be generated. This is a general failure condition.
  • OFF: a entropy_available callback will not be called in the future, because the entropy generator is off/not powered.
source

fn cancel(&self) -> Result<(), ErrorCode>

Cancel acquisition of entropy.

There are three valid return values:

  • Ok(()): an outstanding request from get has been cancelled, or there was no outstanding request. No entropy_available callback will be issued.
  • FAIL:: There will be a entropy_available callback, which may or may not return an error code.
source

fn set_client(&'a self, _: &'a dyn Client8)

Set the client to receive entropy_available callbacks.

Implementors§