Add a comment advertising NullTrapSink.

2018-04-19 09:40:46 -07:00
parent 07576d3ed0
commit 5bc0e0e188
1 changed files with 3 additions and 0 deletions
--- a/lib/codegen/src/binemit/memorysink.rs
+++ b/lib/codegen/src/binemit/memorysink.rs
@@ -68,6 +68,9 @@ pub trait RelocSink {
 }

 /// A trait for receiving trap codes and offsets.
+///
+/// If you don't need information about possible traps, you can use the
+/// [`NullTrapSink`](binemit/trait.TrapSink.html) implementation.
 pub trait TrapSink {
    /// Add trap information for a specific offset.
    fn trap(&mut self, CodeOffset, SourceLoc, TrapCode);