Add hal::poll(hal::timeout, polling_function)

[kammce]

Provides a utility that polls a function until it either indicates that it has completed its work or , then the function throws embed::error::timeout, otherwise it returns success.

[SameerAzer]

I can help with this one

[kammce]

Thank you @SameerAzer ! can you type in .take here so you can assign yourself to this issue.

[github-actions]

Thanks for taking this issue! Let us know if you have any questions!

[kammce]

@SameerAzer actually nvm, I assigned you! Thank you for taking this on!

[SameerAzer]

Does this belong in libembeddedhal/timeout.hpp ? @kammce

[kammce]

Yes, it should be in timeout.hpp

[SameerAzer]

What's polling_function's signature? boost::leaf::result<bool>(void) ??

[kammce]

boost::leaf::result<void> type can be used to indicate success or if an error was thrown. embed::poll executes a polling_function until it is either finished, successful poll, or until the timeout times out, return boost::leaf::new_error(embed::error::timeout{}).

I'm not sure when poll would return true/false otherwise.

[kammce]

Oh sorry, I misread this. The polling function signature should be boost::leaf::result<bool>(void) where the success value of false means that the polling function has not yet finished its work, true means its work is finished and an error will be transmitted upwards.