diff options
Diffstat (limited to 'embassy-nrf/src/buffered_uarte/mod.rs')
| -rw-r--r-- | embassy-nrf/src/buffered_uarte/mod.rs | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/embassy-nrf/src/buffered_uarte/mod.rs b/embassy-nrf/src/buffered_uarte/mod.rs new file mode 100644 index 000000000..75d84baac --- /dev/null +++ b/embassy-nrf/src/buffered_uarte/mod.rs | |||
| @@ -0,0 +1,14 @@ | |||
| 1 | //! Async buffered UART driver. | ||
| 2 | //! | ||
| 3 | //! Note that discarding a future from a read or write operation may lead to losing | ||
| 4 | //! data. For example, when using `futures_util::future::select` and completion occurs | ||
| 5 | //! on the "other" future, you should capture the incomplete future and continue to use | ||
| 6 | //! it for the next read or write. This pattern is a consideration for all IO, and not | ||
| 7 | //! just serial communications. | ||
| 8 | //! | ||
| 9 | //! Please also see [crate::uarte] to understand when [BufferedUarte] should be used. | ||
| 10 | #[cfg_attr(not(feature = "_nrf54l"), path = "v1.rs")] | ||
| 11 | #[cfg_attr(feature = "_nrf54l", path = "v2.rs")] | ||
| 12 | mod _version; | ||
| 13 | |||
| 14 | pub use _version::*; | ||
