Skip to content

Commit

Permalink
Merge #355
Browse files Browse the repository at this point in the history
355: Clarify docs on `Write::write` r=japaric a=jonas-schievink

Fixes #168

Co-authored-by: Jonas Schievink <jonasschievink@gmail.com>
  • Loading branch information
bors[bot] and jonas-schievink authored Jan 21, 2021
2 parents 574f77f + 0231567 commit e67e6f6
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -633,6 +633,9 @@ pub trait Write {
///
/// This will be called by the defmt logging macros to transmit encoded data. The write
/// operation must not fail.
///
/// Note that a call to `write` does *not* correspond to a defmt logging macro invocation. A
/// single `defmt::info!` call can result in an arbitrary number of `write` calls.
fn write(&mut self, bytes: &[u8]);
}

Expand Down

0 comments on commit e67e6f6

Please sign in to comment.