Skip to content

Commit 2a1d472

Browse files
jdidionjdidion
committed
fix doc tests
1 parent 81d1ff3 commit 2a1d472

File tree

5 files changed

+29
-29
lines changed

5 files changed

+29
-29
lines changed

‎src/hive/builder/open.rs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ impl OpenBuilder {
5252
/// # Examples
5353
///
5454
/// ```
55-
/// # use beekeeper::hive::{Builder, ChannelBuilder, Hive};
55+
/// # use beekeeper::hive::prelude::*;
5656
/// # use beekeeper::bee::{Context, QueenMut, Worker, WorkerResult};
5757
///
5858
/// #[derive(Debug)]
@@ -103,7 +103,7 @@ impl OpenBuilder {
103103
/// }
104104
///
105105
/// # fn main() {
106-
/// let hive = ChannelBuilder::empty()
106+
/// let hive = channel_builder(false)
107107
/// .num_threads(8)
108108
/// .thread_stack_size(4_000_000)
109109
/// .with_queen_mut_default::<CounterQueen>()
@@ -138,7 +138,7 @@ impl OpenBuilder {
138138
/// # Examples
139139
///
140140
/// ```
141-
/// # use beekeeper::hive::{Builder, ChannelBuilder, OutcomeIteratorExt};
141+
/// # use beekeeper::hive::prelude::*;
142142
/// # use beekeeper::bee::{Context, Worker, WorkerResult};
143143
///
144144
/// #[derive(Debug, Clone)]
@@ -170,7 +170,7 @@ impl OpenBuilder {
170170
/// }
171171
///
172172
/// # fn main() {
173-
/// let hive = ChannelBuilder::empty()
173+
/// let hive = channel_builder(false)
174174
/// .num_threads(8)
175175
/// .thread_stack_size(4_000_000)
176176
/// .with_worker(MathWorker(5isize))
@@ -196,7 +196,7 @@ impl OpenBuilder {
196196
/// # Examples
197197
///
198198
/// ```
199-
/// # use beekeeper::hive::{Builder, ChannelBuilder, OutcomeIteratorExt};
199+
/// # use beekeeper::hive::prelude::*;
200200
/// # use beekeeper::bee::{Context, Worker, WorkerResult};
201201
/// # use std::num::NonZeroIsize;
202202
///
@@ -222,7 +222,7 @@ impl OpenBuilder {
222222
/// }
223223
///
224224
/// # fn main() {
225-
/// let hive = ChannelBuilder::empty()
225+
/// let hive = channel_builder(false)
226226
/// .num_threads(8)
227227
/// .thread_stack_size(4_000_000)
228228
/// .with_worker_default::<MathWorker>()

‎src/hive/hive.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -463,12 +463,12 @@ impl<W: Worker, Q: Queen<Kind = W>, T: TaskQueues<W>> Hive<Q, T> {
463463
///
464464
/// ```
465465
/// use beekeeper::bee::stock::{Thunk, ThunkWorker};
466-
/// use beekeeper::hive::{Builder, ChannelBuilder};
466+
/// use beekeeper::hive::prelude::*;
467467
/// use std::thread;
468468
/// use std::time::Duration;
469469
///
470470
/// # fn main() {
471-
/// let hive = ChannelBuilder::empty()
471+
/// let hive = channel_builder(false)
472472
/// .num_threads(4)
473473
/// .with_worker_default::<ThunkWorker<()>>()
474474
/// .build();

‎src/hive/inner/builder.rs‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ pub trait Builder: BuilderConfig + Sized {
2020
///
2121
/// ```
2222
/// use beekeeper::bee::stock::{Thunk, ThunkWorker};
23-
/// use beekeeper::hive::{Builder, ChannelBuilder, Hive};
23+
/// use beekeeper::hive::prelude::*;
2424
///
2525
/// # fn main() {
26-
/// let hive = ChannelBuilder::empty()
26+
/// let hive = channel_builder(false)
2727
/// .num_threads(8)
2828
/// .with_worker_default::<ThunkWorker<()>>()
2929
/// .build();
@@ -57,10 +57,10 @@ pub trait Builder: BuilderConfig + Sized {
5757
///
5858
/// ```
5959
/// use beekeeper::bee::stock::{Thunk, ThunkWorker};
60-
/// use beekeeper::hive::{Builder, ChannelBuilder, Hive};
60+
/// use beekeeper::hive::prelude::*;
6161
///
6262
/// # fn main() {
63-
/// let hive = ChannelBuilder::empty()
63+
/// let hive = channel_builder(false)
6464
/// .with_thread_per_core()
6565
/// .with_worker_default::<ThunkWorker<()>>()
6666
/// .build();
@@ -89,11 +89,11 @@ pub trait Builder: BuilderConfig + Sized {
8989
///
9090
/// ```
9191
/// use beekeeper::bee::stock::{Thunk, ThunkWorker};
92-
/// use beekeeper::hive::{Builder, ChannelBuilder, Hive};
92+
/// use beekeeper::hive::prelude::*;
9393
/// use std::thread;
9494
///
9595
/// # fn main() {
96-
/// let hive = ChannelBuilder::default()
96+
/// let hive = channel_builder(true)
9797
/// .thread_name("foo")
9898
/// .with_worker_default::<ThunkWorker<()>>()
9999
/// .build();
@@ -123,10 +123,10 @@ pub trait Builder: BuilderConfig + Sized {
123123
///
124124
/// ```
125125
/// use beekeeper::bee::stock::{Thunk, ThunkWorker};
126-
/// use beekeeper::hive::{Builder, ChannelBuilder, Hive};
126+
/// use beekeeper::hive::prelude::*;
127127
///
128128
/// # fn main() {
129-
/// let hive = ChannelBuilder::default()
129+
/// let hive = channel_builder(true)
130130
/// .thread_stack_size(4_000_000)
131131
/// .with_worker_default::<ThunkWorker<()>>()
132132
/// .build();
@@ -161,10 +161,10 @@ pub trait Builder: BuilderConfig + Sized {
161161
///
162162
/// ```
163163
/// use beekeeper::bee::stock::{Thunk, ThunkWorker};
164-
/// use beekeeper::hive::{Builder, ChannelBuilder, Hive};
164+
/// use beekeeper::hive::prelude::*;
165165
///
166166
/// # fn main() {
167-
/// let hive = ChannelBuilder::empty()
167+
/// let hive = channel_builder(false)
168168
/// .num_threads(4)
169169
/// .core_affinity(0..4)
170170
/// .with_worker_default::<ThunkWorker<()>>()
@@ -237,7 +237,7 @@ pub trait Builder: BuilderConfig + Sized {
237237
/// ```
238238
/// use beekeeper::bee::{ApplyError, Context};
239239
/// use beekeeper::bee::stock::RetryCaller;
240-
/// use beekeeper::hive::{Builder, ChannelBuilder, Hive};
240+
/// use beekeeper::hive::prelude::*;
241241
/// use std::time;
242242
///
243243
/// fn sometimes_fail(
@@ -253,7 +253,7 @@ pub trait Builder: BuilderConfig + Sized {
253253
/// }
254254
///
255255
/// # fn main() {
256-
/// let hive = ChannelBuilder::default()
256+
/// let hive = channel_builder(true)
257257
/// .max_retries(3)
258258
/// .with_worker(RetryCaller::of(sometimes_fail))
259259
/// .build();
@@ -284,7 +284,7 @@ pub trait Builder: BuilderConfig + Sized {
284284
/// ```
285285
/// use beekeeper::bee::{ApplyError, Context};
286286
/// use beekeeper::bee::stock::RetryCaller;
287-
/// use beekeeper::hive::{Builder, ChannelBuilder, Hive};
287+
/// use beekeeper::hive::prelude::*;
288288
/// use std::time;
289289
///
290290
/// fn echo_time(i: usize, ctx: &Context<usize>) -> Result<String, ApplyError<usize, String>> {
@@ -299,7 +299,7 @@ pub trait Builder: BuilderConfig + Sized {
299299
/// }
300300
///
301301
/// # fn main() {
302-
/// let hive = ChannelBuilder::default()
302+
/// let hive = channel_builder(true)
303303
/// .max_retries(3)
304304
/// .retry_factor(time::Duration::from_secs(1))
305305
/// .with_worker(RetryCaller::of(echo_time))

‎src/hive/mod.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@
3232
//! the `Builder`.
3333
//!
3434
//! ```
35-
//! use beekeeper::hive::{Builder, ChannelBuilder};
35+
//! use beekeeper::hive::prelude::*;
3636
//! # type MyWorker1 = beekeeper::bee::stock::EchoWorker<usize>;
3737
//! # type MyWorker2 = beekeeper::bee::stock::EchoWorker<u32>;
3838
//!
39-
//! let builder1 = ChannelBuilder::default();
39+
//! let builder1 = channel_builder(true);
4040
//! let builder2 = builder1.clone();
4141
//!
4242
//! let hive1 = builder1.with_worker_default::<MyWorker1>().build();
@@ -79,10 +79,10 @@
7979
//! started with no core affinity.
8080
//!
8181
//! ```
82-
//! use beekeeper::hive::{Builder, ChannelBuilder};
82+
//! use beekeeper::hive::prelude::*;
8383
//! # type MyWorker = beekeeper::bee::stock::EchoWorker<usize>;
8484
//!
85-
//! let hive = ChannelBuilder::empty()
85+
//! let hive = channel_builder(false)
8686
//! .num_threads(4)
8787
//! // 16 cores will be available for pinning but only 4 will be used initially
8888
//! .core_affinity(0..16)
@@ -223,7 +223,7 @@
223223
//! `Sender` is dropped. Since `Receiver` implements `Iterator`, you can use the methods of
224224
//! [`OutcomeIteratorExt`] to iterate over the outcomes for specific task IDs.
225225
//!
226-
//! ```no_run
226+
//! ```rust,ignore
227227
//! use beekeeper::hive::prelude::*;
228228
//! let (tx, rx) = outcome_channel();
229229
//! let hive = ...

‎src/lib.rs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@
151151
//! # fn main() {
152152
//! // create a hive to process `Thunk`s - no-argument closures with the
153153
//! // same return type (`i32`)
154-
//! let hive = ChannelBuilder::empty()
154+
//! let hive = channel_builder(false)
155155
//! .num_threads(4)
156156
//! .thread_name("thunk_hive")
157157
//! .with_worker_default::<ThunkWorker<i32>>()
@@ -278,7 +278,7 @@
278278
//!
279279
//! # fn main() {
280280
//! // build the Hive
281-
//! let hive = ChannelBuilder::empty()
281+
//! let hive = channel_builder(false)
282282
//! .num_threads(4)
283283
//! .with_queen_mut_default::<CatQueen>()
284284
//! .build();

0 commit comments

Comments
 (0)