Skip to content

Commit

Permalink
tests: doc: remove glob imports
Browse files Browse the repository at this point in the history
  • Loading branch information
@y86-dev
y86-dev committed Apr 20, 2024
1 parent c102cb2 commit 3799b8b
Showing 1 changed file with 43 additions and 27 deletions.
70 changes: 43 additions & 27 deletions src/lib.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@
//! ```
//! # #![allow(clippy::disallowed_names)]
//! # #![feature(allocator_api)]
//! use pinned_init::*;
//! use pinned_init::{pin_data, pin_init};
//! # use core::pin::Pin;
//! # #[path = "../examples/mutex.rs"] mod mutex; use mutex::*;
//! #[pin_data]
Expand All @@ -77,6 +77,7 @@
//! a <- CMutex::new(42),
//! b: 24,
//! });
//! # use pinned_init::InPlaceInit;
//! # let _ = Box::pin_init(foo);
//! ```
//!
Expand All @@ -87,7 +88,7 @@
//! # #![allow(clippy::disallowed_names)]
//! # #![feature(allocator_api)]
//! # #[path = "../examples/mutex.rs"] mod mutex; use mutex::*;
//! # use pinned_init::*;
//! # use pinned_init::{pin_data, pin_init};
//! # use core::pin::Pin;
//! # #[pin_data]
//! # struct Foo {
Expand All @@ -99,6 +100,8 @@
//! # a <- CMutex::new(42),
//! # b: 24,
//! # });
//! use pinned_init::InPlaceInit;
//!
//! let foo: Result<Pin<Box<Foo>>, _> = Box::pin_init(foo);
//! ```
//!
Expand All @@ -112,9 +115,10 @@
//! ```
//! # #![feature(allocator_api)]
//! # #[path = "../examples/mutex.rs"] mod mutex; use mutex::*;
//! # use pinned_init::*;
//! # use std::sync::Arc;
//! # use core::pin::Pin;
//! use pinned_init::InPlaceInit;
//!
//! let mtx: Result<Pin<Arc<CMutex<usize>>>, _> = Arc::pin_init(CMutex::new(42));
//! ```
//!
Expand All @@ -123,8 +127,9 @@
//! ```
//! # #![allow(clippy::disallowed_names)]
//! # #![feature(allocator_api)]
//! # use pinned_init::*;
//! # #[path = "../examples/mutex.rs"] mod mutex; use mutex::*;
//! use pinned_init::{pin_data, try_pin_init, PinInit, InPlaceInit};
//!
//! #[pin_data]
//! struct DriverData {
//! #[pin]
Expand Down Expand Up @@ -158,7 +163,7 @@
//!
//! ```
//! # #![feature(extern_types)]
//! use pinned_init::*;
//! use pinned_init::{pin_data, pinned_drop, pin_init_from_closure, PinInit};
//! use core::{ptr::addr_of_mut, marker::PhantomPinned, cell::UnsafeCell, pin::Pin};
//! mod bindings {
//! extern "C" {
Expand Down Expand Up @@ -287,7 +292,7 @@ pub mod __internal;
/// ```
/// # #![feature(allocator_api)]
/// # #[path = "../examples/mutex.rs"] mod mutex; use mutex::*;
/// use pinned_init::*;
/// use pinned_init::pin_data;
///
/// #[pin_data]
/// struct CountedBuffer {
Expand All @@ -304,7 +309,7 @@ pub mod __internal;
/// ```
/// # #![feature(allocator_api)]
/// # #[path = "../examples/mutex.rs"] mod mutex; use mutex::*;
/// use pinned_init::*;
/// use pinned_init::{pin_data, pinned_drop};
/// use std::pin::Pin;
///
/// #[pin_data(PinnedDrop)]
Expand Down Expand Up @@ -340,7 +345,7 @@ pub use pinned_init_macro::pin_data;
/// ```
/// # #![feature(allocator_api)]
/// # #[path = "../examples/mutex.rs"] mod mutex; use mutex::*;
/// use pinned_init::*;
/// use pinned_init::{pin_data, pinned_drop};
/// use std::pin::Pin;
///
/// #[pin_data(PinnedDrop)]
Expand Down Expand Up @@ -372,7 +377,7 @@ pub use pinned_init_macro::pinned_drop;
/// # Examples
///
/// ```
/// use pinned_init::*;
/// use pinned_init::Zeroable;
///
/// #[derive(Zeroable)]
/// pub struct DriverData {
Expand All @@ -386,7 +391,7 @@ pub use pinned_init_macro::pinned_drop;
/// trait.
///
/// ```
/// use pinned_init::*;
/// use pinned_init::Zeroable;
///
/// #[derive(Zeroable)]
/// pub struct Data<T> {
Expand All @@ -404,8 +409,9 @@ pub use pinned_init_macro::Zeroable;
/// # #![allow(clippy::disallowed_names)]
/// # #![feature(allocator_api)]
/// # #[path = "../examples/mutex.rs"] mod mutex; use mutex::*;
/// # use pinned_init::*;
/// # use core::pin::Pin;
/// use pinned_init::{pin_data, stack_pin_init, pin_init};
///
/// #[pin_data]
/// struct Foo {
/// #[pin]
Expand Down Expand Up @@ -456,7 +462,8 @@ macro_rules! stack_pin_init {
/// # #![allow(clippy::disallowed_names)]
/// # #![feature(allocator_api)]
/// # #[path = "../examples/mutex.rs"] mod mutex; use mutex::*;
/// # use pinned_init::*;
/// use pinned_init::{pin_data, stack_try_pin_init, try_pin_init};
///
/// #[pin_data]
/// struct Foo {
/// #[pin]
Expand All @@ -482,7 +489,8 @@ macro_rules! stack_pin_init {
/// # #![allow(clippy::disallowed_names)]
/// # #![feature(allocator_api)]
/// # #[path = "../examples/mutex.rs"] mod mutex; use mutex::*;
/// # use pinned_init::*;
/// use pinned_init::{pin_data, stack_try_pin_init, try_pin_init};
///
/// #[pin_data]
/// struct Foo {
/// #[pin]
Expand Down Expand Up @@ -546,7 +554,7 @@ macro_rules! stack_try_pin_init {
/// ```
/// # #![feature(allocator_api)]
/// # #[path = "../examples/mutex.rs"] mod mutex; use mutex::*;
/// use pinned_init::*;
/// use pinned_init::{pin_data, pin_init, PinInit};
///
/// // Add `#[pin_data]` on your struct:
/// #[pin_data]
Expand Down Expand Up @@ -574,6 +582,7 @@ macro_rules! stack_try_pin_init {
/// })
/// }
/// }
/// # use pinned_init::InPlaceInit;
/// # let _ = Box::pin_init(CountedBuffer::new([0; 1024]));
/// ```
///
Expand All @@ -587,7 +596,8 @@ macro_rules! stack_try_pin_init {
/// ```
/// # #![feature(allocator_api)]
/// # #[path = "../examples/mutex.rs"] mod mutex; use mutex::*;
/// use pinned_init::*;
/// use pinned_init::{pin_data, try_pin_init, PinInit, zeroed, InPlaceInit};
///
/// #[pin_data]
/// struct BigCountedBuf {
/// buf: Box<[u8; 1024 * 1024 * 1024]>,
Expand Down Expand Up @@ -617,7 +627,7 @@ macro_rules! stack_try_pin_init {
/// ```
/// # #![feature(allocator_api)]
/// # #[path = "../examples/mutex.rs"] mod mutex; use mutex::*;
/// # use pinned_init::*;
/// # use pinned_init::{InPlaceInit, zeroed};
/// # #[pin_data]
/// # struct BigCountedBuf {
/// # buf: Box<[u8; 1024 * 1024 * 1024]>,
Expand All @@ -636,6 +646,8 @@ macro_rules! stack_try_pin_init {
/// # }? Error)
/// # }
/// # }
/// use pinned_init::{pin_data, try_pin_init, PinInit};
///
/// #[pin_data]
/// struct MultiBuf {
/// #[pin]
Expand Down Expand Up @@ -665,7 +677,8 @@ macro_rules! stack_try_pin_init {
/// ```
/// # #![feature(allocator_api)]
/// # #[path = "../examples/mutex.rs"] mod mutex; use mutex::*;
/// use pinned_init::*;
/// use pinned_init::{init, Zeroable, Init};
///
/// #[derive(Zeroable)]
/// struct Config {
/// max_size: usize,
Expand Down Expand Up @@ -695,7 +708,7 @@ macro_rules! stack_try_pin_init {
/// do this by adding a [`PhantomPinned`] field to your struct:
///
/// ```
/// use pinned_init::*;
/// use pinned_init::pin_data;
/// use core::marker::PhantomPinned;
///
/// #[pin_data]
Expand All @@ -714,7 +727,7 @@ macro_rules! stack_try_pin_init {
/// the initializer:
///
/// ```
/// # use pinned_init::*;
/// # use pinned_init::{pin_data, pin_init, PinInit};
/// # use core::{ptr::NonNull, marker::PhantomPinned};
/// # #[pin_data]
/// # pub struct ListLink {
Expand All @@ -738,7 +751,7 @@ macro_rules! stack_try_pin_init {
/// The type of `this` is [`NonNull<Self>`]. Here is an example of how to use it:
///
/// ```
/// use pinned_init::*;
/// use pinned_init::{pin_data, pin_init, PinInit};
/// use core::{ptr::NonNull, marker::PhantomPinned};
///
/// #[pin_data]
Expand Down Expand Up @@ -852,7 +865,8 @@ pub unsafe trait PinInit<T: ?Sized, E = Infallible>: Sized {
/// ```
/// # #![feature(allocator_api)]
/// # #[path = "../examples/mutex.rs"] mod mutex; use mutex::*;
/// # use pinned_init::*;
/// use pinned_init::PinInit;
///
/// let mtx_init = CMutex::new(42);
/// // Make the initializer print the value.
/// let mtx_init = mtx_init.pin_chain(|mtx| {
Expand Down Expand Up @@ -917,7 +931,8 @@ pub unsafe trait Init<T: ?Sized, E = Infallible>: PinInit<T, E> {
///
/// ```
/// # #![allow(clippy::disallowed_names)]
/// # use pinned_init::*;
/// use pinned_init::{init, zeroed, Init};
///
/// struct Foo {
/// buf: [u8; 1_000_000],
/// }
Expand Down Expand Up @@ -995,8 +1010,8 @@ pub fn uninit<T, E>() -> impl Init<MaybeUninit<T>, E> {
/// # Examples
///
/// ```
/// # use pinned_init::*;
/// use pinned_init::init_array_from_fn;
/// use pinned_init::{init_array_from_fn, InPlaceInit};
///
/// let array: Box<[usize; 1_000]> = Box::init(init_array_from_fn(|i| i)).unwrap();
/// assert_eq!(array.len(), 1_000);
/// ```
Expand Down Expand Up @@ -1038,10 +1053,10 @@ where
/// ```
/// # #![feature(allocator_api)]
/// # #[path = "../examples/mutex.rs"] mod mutex; use mutex::*;
/// # use pinned_init::*;
/// # use core::pin::Pin;
/// use pinned_init::pin_init_array_from_fn;
/// use pinned_init::{pin_init_array_from_fn, InPlaceInit};
/// use std::sync::Arc;
///
/// let array: Pin<Arc<[CMutex<usize>; 1_000]>> =
/// Arc::pin_init(pin_init_array_from_fn(|i| CMutex::new(i))).unwrap();
/// assert_eq!(array.len(), 1_000);
Expand Down Expand Up @@ -1206,8 +1221,9 @@ impl<T> InPlaceInit<T> for Arc<T> {
/// ```
/// # #![feature(allocator_api)]
/// # #[path = "../examples/mutex.rs"] mod mutex; use mutex::*;
/// # use pinned_init::*;
/// use pinned_init::{pin_data, pinned_drop};
/// use core::pin::Pin;
///
/// #[pin_data(PinnedDrop)]
/// struct Foo {
/// #[pin]
Expand Down

0 comments on commit 3799b8b

Please sign in to comment.