itsscb/embassy
1
0
Fork 0
mirror of https://github.com/embassy-rs/embassy.git synced 2025-09-28 12:50:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

remove line break reference from documentation

Browse Source
This commit is contained in:
Matt Bhagat-Conway 2025-07-03 11:54:00 -04:00
parent 6545b05188
commit da6c4ff31a
No known key found for this signature in database
GPG Key ID: EB64FF36E7DA441A
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
embassy-rp/src/uart/mod.rs
View File

@ -495,57 +495,57 @@ impl<'d> UartRx<'d, Async> {
unreachable!("unrecognized rx error");
}
/// Read from the UART, waiting for a line break.
/// Read from the UART, waiting for a break.
///
/// We read until one of the following occurs:
///
/// * We read `buffer.len()` bytes without a line break
/// * We read `buffer.len()` bytes without a break
/// * returns `Err(ReadToBreakError::MissingBreak(buffer.len()))`
/// * We read `n` bytes then a line break occurs
/// * We read `n` bytes then a break occurs
/// * returns `Ok(n)`
/// * We encounter some error OTHER than a line break
/// * We encounter some error OTHER than a break
/// * returns `Err(ReadToBreakError::Other(error))`
///
/// **NOTE**: you MUST provide a buffer one byte larger than your largest expected
/// message to reliably detect the framing on one single call to `read_to_break()`.
///
/// * If you expect a message of 20 bytes + line break, and provide a 20-byte buffer:
/// * If you expect a message of 20 bytes + break, and provide a 20-byte buffer:
/// * The first call to `read_to_break()` will return `Err(ReadToBreakError::MissingBreak(20))`
/// * The next call to `read_to_break()` will immediately return `Ok(0)`, from the "stale" line break
/// * If you expect a message of 20 bytes + line break, and provide a 21-byte buffer:
/// * The next call to `read_to_break()` will immediately return `Ok(0)`, from the "stale" break
/// * If you expect a message of 20 bytes + break, and provide a 21-byte buffer:
/// * The first call to `read_to_break()` will return `Ok(20)`.
/// * The next call to `read_to_break()` will work as expected
///
/// **NOTE**: In the UART context, a line break refers to a break condition (the line being held low for
/// **NOTE**: In the UART context, a break refers to a break condition (the line being held low for
/// for longer than a single character), not an ASCII line break.
pub async fn read_to_break(&mut self, buffer: &mut [u8]) -> Result<usize, ReadToBreakError> {
self.read_to_break_with_count(buffer, 0).await
}
/// Read from the UART, waiting for a line break as soon as at least `min_count` bytes have been read.
/// Read from the UART, waiting for a break as soon as at least `min_count` bytes have been read.
///
/// We read until one of the following occurs:
///
/// * We read `buffer.len()` bytes without a line break
/// * We read `buffer.len()` bytes without a break
/// * returns `Err(ReadToBreakError::MissingBreak(buffer.len()))`
/// * We read `n > min_count` bytes then a line break occurs
/// * We read `n > min_count` bytes then a break occurs
/// * returns `Ok(n)`
/// * We encounter some error OTHER than a line break
/// * We encounter some error OTHER than a break
/// * returns `Err(ReadToBreakError::Other(error))`
///
/// If a line break occurs before `min_count` bytes have been read, the break will be ignored and the read will continue
/// If a break occurs before `min_count` bytes have been read, the break will be ignored and the read will continue
///
/// **NOTE**: you MUST provide a buffer one byte larger than your largest expected
/// message to reliably detect the framing on one single call to `read_to_break()`.
///
/// * If you expect a message of 20 bytes + line break, and provide a 20-byte buffer:
/// * If you expect a message of 20 bytes + break, and provide a 20-byte buffer:
/// * The first call to `read_to_break()` will return `Err(ReadToBreakError::MissingBreak(20))`
/// * The next call to `read_to_break()` will immediately return `Ok(0)`, from the "stale" line break
/// * If you expect a message of 20 bytes + line break, and provide a 21-byte buffer:
/// * If you expect a message of 20 bytes + break, and provide a 21-byte buffer:
/// * The first call to `read_to_break()` will return `Ok(20)`.
/// * The next call to `read_to_break()` will work as expected
///
/// **NOTE**: In the UART context, a line break refers to a break condition (the line being held low for
/// **NOTE**: In the UART context, a break refers to a break condition (the line being held low for
/// for longer than a single character), not an ASCII line break.
pub async fn read_to_break_with_count(
&mut self,