LailaTheElf/embassy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: improve comment

Browse Source
This commit is contained in:
elagil 2024-11-28 17:45:00 +01:00
parent 152d8ee0d9
commit 5d2b38c979
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
embassy-stm32/src/dma/ringbuffer/mod.rs
View File

@ -253,10 +253,17 @@ impl<'a, W: Word> WritableDmaRingBuffer<'a, W> {
/// Write elements directly to the buffer. /// Write elements directly to the buffer.
/// ///
/// Subsequent writes will overwrite the content of the buffer, so it is not useful to call this more than once.
/// Data is aligned towards the end of the buffer. /// Data is aligned towards the end of the buffer.
///
/// In case of success, returns the written length, and the empty space in front of the written block.
/// Fails if the data to write exceeds the buffer capacity.
pub fn write_immediate(&mut self, buf: &[W]) -> Result<(usize, usize), Error> { pub fn write_immediate(&mut self, buf: &[W]) -> Result<(usize, usize), Error> {
let start = self.cap() - buf.len(); if buf.len() > self.cap() {
return Err(Error::Overrun);
}
let start = self.cap() - buf.len();
for (i, data) in buf.iter().enumerate() { for (i, data) in buf.iter().enumerate() {
self.write_buf(start + i, *data) self.write_buf(start + i, *data)
} }