mirror of
https://github.com/openharmony/third_party_rust_memoffset.git
synced 2026-07-21 01:45:27 -04:00
Modernize doc examples to use idiomatic Rust
This commit is contained in:
@@ -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
@@ -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
@@ -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
@@ -59,8 +59,7 @@ macro_rules! _memoffset__compile_error {
|
||||
///
|
||||
/// ## Examples
|
||||
/// ```
|
||||
/// #[macro_use]
|
||||
/// extern crate memoffset;
|
||||
/// use memoffset::span_of;
|
||||
///
|
||||
/// #[repr(C)]
|
||||
/// struct Florp {
|
||||
|
||||
Reference in New Issue
Block a user