Add documentation

This commit is contained in:
René van Dorst 2024-10-22 22:09:24 +02:00
parent 4d431f2d66
commit df9e662b50

View File

@ -64,12 +64,26 @@ mod thread {
} }
} }
/// `Signaler` is used in `__pender()`;
///
/// This is only needed when creating a [`raw::Executor`].
///
/// # Example
/// ```rust
/// let signaler = Box::leak(Box::new(Signaler::new()));
/// let executor = &*Box::leak(Box::new(Executor::new(signaler)));
///
/// executor.spawner().spawn(/* EmbassyTask(Arguments) */).unwrap();
///
/// unsafe { executor.poll() };
/// ```
pub struct Signaler { pub struct Signaler {
mutex: Mutex<bool>, mutex: Mutex<bool>,
condvar: Condvar, condvar: Condvar,
} }
impl Signaler { impl Signaler {
/// Create a new Signaler.
pub fn new() -> Self { pub fn new() -> Self {
Self { Self {
mutex: Mutex::new(false), mutex: Mutex::new(false),