Skip to content

Commit 23dbd28

Browse files
committed
timestamps: document panic
1 parent 6530e8c commit 23dbd28

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

itm/src/lib.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -549,6 +549,12 @@ where
549549
}
550550

551551
/// Returns an iterator over [`TimestampedTracePackets`](TimestampedTracePackets).
552+
///
553+
/// # Panics
554+
///
555+
/// This iterator constuctor will panic if
556+
/// [`options.lts_prescaler`](TimestampsConfiguration::lts_prescaler)
557+
/// is [`Disabled`](LocalTimestampOptions::Disabled).
552558
pub fn timestamps(&mut self, options: TimestampsConfiguration) -> Timestamps<R> {
553559
Timestamps::new(self, options)
554560
}

0 commit comments

Comments
 (0)