Skip to content
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

Add example of opaque CountDown type usage #109

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/timer.rs
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,23 @@ use void::Void;
/// # fn wait(&mut self) -> ::nb::Result<(), Void> { Ok(()) }
/// # }
/// ```
///
/// If you want to use a CountDown timer as an opaque type in a HAL-based driver, you have to add
/// some type bounds to make sure arguments passed to `start` can be used by the underlying
/// (concrete) `CountDown::Time` type:
/// ```rust
/// extern crate embedded_hal as hal;
/// #[macro_use(block)]
thenewwazoo marked this conversation as resolved.
Show resolved Hide resolved
///
/// pub fn uses_timer<T, U>(t: T)
mathk marked this conversation as resolved.
Show resolved Hide resolved
/// where
/// T: hal::timer::CountDown<Time=U>,
/// U: From<u32>,
/// {
/// // delay an arbitrary 1 time unit
/// t.start(1);
/// }
/// ```
pub trait CountDown {
/// The unit of time used by this timer
type Time;
Expand Down