aboutsummaryrefslogtreecommitdiff
path: root/src/annotation/mod.rs
diff options
context:
space:
mode:
authoriximeow <me@iximeow.net>2024-06-22 11:19:35 -0700
committeriximeow <me@iximeow.net>2024-06-22 11:19:39 -0700
commit4f9d10e7c840bbcb29991c978a5c07b001e7fcd5 (patch)
treec8774c9be3a07d4822a5ba3940f4f9df3e2c5c05 /src/annotation/mod.rs
parentf73579421525142cb31fd3b2325a1d1447b5fdab (diff)
fix annotation doc test not compiling under nostd
... this makes the doc test not exist under nostd, yes. `VecSink` does not have a no-std alternative that makes the example reasonable.
Diffstat (limited to 'src/annotation/mod.rs')
-rw-r--r--src/annotation/mod.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/annotation/mod.rs b/src/annotation/mod.rs
index 0248b94..0d1f1f8 100644
--- a/src/annotation/mod.rs
+++ b/src/annotation/mod.rs
@@ -19,6 +19,8 @@
//! in a generic setting, there isn't much to do with a `FieldDescription` other than display it. a
//! typical use might look something like:
//! ```
+//! #[cfg(feature="std")]
+//! # {
//! use core::fmt;
//!
//! use yaxpeax_arch::annotation::{AnnotatingDecoder, VecSink};
@@ -40,6 +42,7 @@
//! println!(" bits [{}, {}]: {}", start, end, desc);
//! }
//! }
+//! # }
//! ```
//!
//! note that the range `[start, end]` for a reported span is _inclusive_. the `end`-th bit of a