NaxdyOrg/embassy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

improve docstring

Browse source
This commit is contained in:
JuliDi 2023-09-09 09:50:24 +02:00
parent cf2d4eca7c
commit 40a18b075d
No known key found for this signature in database
GPG key ID: 0C98FD5D6597BC5B
1 changed files with 5 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
embassy-net/src/lib.rs
View file

@ -367,13 +367,12 @@ impl<D: Driver + 'static> Stack<D> {
}
/// Wait for the network stack to obtain a valid IP configuration.
/// Returns instantly if [`Stack::is_config_up`] returns `true`.
///
/// ## Watch out:
/// The Future is polled only when the [`Stack`] is running,
/// e.g. call `spawner.spawn(net_task(stack))`.
/// ## Notes:
/// - Ensure [`Stack::run`] has been called before using this function.
///
/// `await`ing before will never yield!
/// - This function may never yield (e.g. if no configuration is obtained through DHCP).
/// The caller is supposed to handle a timeout for this case.
///
/// ## Example
/// ```ignore
@ -385,7 +384,7 @@ impl<D: Driver + 'static> Stack<D> {
/// make_static!(embassy_net::StackResources::<2>::new()),
/// seed
/// ));
/// // Launch network task
/// // Launch network task that runs `stack.run().await`
/// spawner.spawn(net_task(stack)).unwrap();
/// // Wait for DHCP config
/// stack.wait_config_up().await;