Modernize doc examples to use idiomatic Rust

This commit is contained in:
Aleksey Kladov
2021-11-12 13:34:26 +03:00
parent b6c2c7fe7d
commit db4bebb157
4 changed files with 6 additions and 18 deletions
+1 -9
View File
@@ -21,17 +21,9 @@ memoffset = "0.6"
These versions will compile fine with rustc versions greater or equal to 1.19.
Add the following lines at the top of your `main.rs` or `lib.rs` files.
```rust,ignore
#[macro_use]
extern crate memoffset;
```
## Examples ##
```rust
#[macro_use]
extern crate memoffset;
use memoffset::{offset_of, span_of};
#[repr(C, packed)]
struct Foo {
+2 -3
View File
@@ -24,8 +24,7 @@
//!
//! ## Examples
//! ```
//! #[macro_use]
//! extern crate memoffset;
//! use memoffset::{offset_of, span_of};
//!
//! #[repr(C, packed)]
//! struct HelpMeIAmTrappedInAStructFactory {
@@ -75,7 +74,7 @@ extern crate doc_comment;
#[cfg(doctest)]
doctest!("../README.md");
/// Hiden module for things the macros need to access.
/// Hidden module for things the macros need to access.
#[doc(hidden)]
pub mod __priv {
#[doc(hidden)]
+2 -4
View File
@@ -72,8 +72,7 @@ macro_rules! _memoffset_offset_from_unsafe {
///
/// ## Examples
/// ```
/// #[macro_use]
/// extern crate memoffset;
/// use memoffset::offset_of;
///
/// #[repr(C, packed)]
/// struct Foo {
@@ -103,8 +102,7 @@ macro_rules! offset_of {
///
/// ## Examples
/// ```
/// #[macro_use]
/// extern crate memoffset;
/// use memoffset::offset_of_tuple;
///
/// fn main() {
/// assert!(offset_of_tuple!((u8, u32), 1) >= 0, "Tuples do not have a defined layout");
+1 -2
View File
@@ -59,8 +59,7 @@ macro_rules! _memoffset__compile_error {
///
/// ## Examples
/// ```
/// #[macro_use]
/// extern crate memoffset;
/// use memoffset::span_of;
///
/// #[repr(C)]
/// struct Florp {