New upstream version 1.67.1+dfsg1

[rustc.git] / vendor / memoffset / src / span_of.rs

diff --git a/vendor/memoffset/src/span_of.rs b/vendor/memoffset/src/span_of.rs
index aab9d0acaf2ffe83e4ffdb03b1dd833c0e422737..89fccce9217effab247f8b4766555b4c9d7e76c3 100644 (file)
--- a/vendor/memoffset/src/span_of.rs
+++ b/vendor/memoffset/src/span_of.rs
@@ -52,11 +52,18 @@ macro_rules! _memoffset__compile_error {
 /// span_of!(Struct, start ..)
 /// ```
 ///
-/// *Note*:
+/// ### Note
 /// This macro uses recursion in order to resolve the range expressions, so there is a limit to
 /// the complexity of the expression.
 /// In order to raise the limit, the compiler's recursion limit should be lifted.
 ///
+/// ### Safety
+/// The inter-field form mentioned above assumes that the first field is positioned before the
+/// second.
+/// This is only guarenteed for `repr(C)` structs.
+/// Usage with `repr(Rust)` structs may yield unexpected results, like downward-going ranges,
+/// spans that include unexpected fields, empty spans, or spans that include *unexpected* padding bytes.
+///
 /// ## Examples
 /// ```
 /// use memoffset::span_of;