remove async from tests

Author: andrewgazelka

src/slice.rs

@@ -80,34 +80,39 @@ impl<T: Sized> BufferExt for T {}
 /// }
 ///
 /// impl<Buf: WriteBuffer> DmaTransfer<Buf> {
+///     /// stars the DMA transfer
 ///     fn start(buf: Buf) -> Self {
-///         // DMA logic
+///         // DMA logic would go here
 ///         Self { buf }
 ///     }
 ///
-///     async fn wait_until_done(&self) {
-///         // to implement
+///     /// returns if DMA transaction is done.
+///     /// this could be called in a polling loop in order to be non-blocking
+///     fn is_done(&self) -> bool {
+///         true
 ///     }
 ///
+///     /// returns resources held by the DMA transfer.
 ///     fn free(self) -> Buf {
 ///         // busy loop which waits until DMA is done to ensure safety
+///         while !self.is_done() {}
 ///         self.buf
 ///     }
 /// }
 ///
 /// /// This function is bad because we cannot obtain the original slice—just a subset of it.
-/// async fn dma_transfer_bad1(buffer: &'static mut [u8], length: usize) -> &'static [u8] {
+/// fn dma_transfer_bad1(buffer: &'static mut [u8], length: usize) -> &'static [u8] {
 ///     let sub_slice = &mut buffer[..length];
 ///     let transfer = DmaTransfer::start(sub_slice);
-///     transfer.wait_until_done().await;
+///     while !transfer.is_done() {}
 ///     transfer.free()
 /// }
 ///
 /// /// This function is bad because we cannot unsplit the slice.
-/// async fn dma_transfer_bad2(buffer: &'static mut [u8], length: usize) -> &'static [u8] {
+/// fn dma_transfer_bad2(buffer: &'static mut [u8], length: usize) -> &'static [u8] {
 ///     let (slice_a, slice_b) = buffer.split_at_mut(length);
 ///     let transfer = DmaTransfer::start(slice_a);
-///     transfer.wait_until_done().await;
+///     while !transfer.is_done() {}
 ///     let slice_a = transfer.free();
 ///     // can't unsplit!!!
 ///     slice_a
@@ -117,8 +122,7 @@ impl<T: Sized> BufferExt for T {}
 /// fn dma_transfer(buffer: &'static mut [u8], length: usize) -> &'static [u8] {
 ///     let buffer_slice = buffer.into_buffer_slice(..length);
 ///     let transfer = DmaTransfer::start(buffer_slice);
-///     // we are commenting this out so we can actually test it without an async runtime
-///     // transfer.wait_until_done().await;
+///     while !transfer.is_done() {}
 ///     let buffer_slice = transfer.free();
 ///     buffer_slice.inner()
 /// }