From 3f8d7999f1ef387817500e5ec1b7c389ecd42052 Mon Sep 17 00:00:00 2001 From: Max Countryman Date: Mon, 28 Oct 2024 11:13:22 -0700 Subject: [PATCH] rename setter methods This renames the setters on workers and schedulers to follow the standard convention. While this is a breaking change, we don't plan to follow proper semver until 0.1.x, so rather than deprecate we've simply renamed. --- src/job.rs | 4 ++-- src/scheduler.rs | 9 ++++----- src/worker.rs | 18 ++++++++---------- 3 files changed, 14 insertions(+), 17 deletions(-) diff --git a/src/job.rs b/src/job.rs index a2b44a7..d100d2f 100644 --- a/src/job.rs +++ b/src/job.rs @@ -1404,10 +1404,10 @@ where let job = self.clone(); let mut worker = Worker::new(queue.clone(), job.clone()); - worker = worker.shutdown_token(shutdown_token.clone()); + worker.set_shutdown_token(shutdown_token.clone()); let mut scheduler = Scheduler::new(queue, job); - scheduler = scheduler.shutdown_token(shutdown_token.clone()); + scheduler.set_shutdown_token(shutdown_token.clone()); // Spawn the tasks using `tokio::spawn` to decouple them from polling the // `Future`. diff --git a/src/scheduler.rs b/src/scheduler.rs index aaccb4c..39feb40 100644 --- a/src/scheduler.rs +++ b/src/scheduler.rs @@ -139,22 +139,21 @@ impl Scheduler { /// # .build() /// # .await?; /// # let task = ExampleTask; - /// # let scheduler = Scheduler::new(queue, task); + /// # let mut scheduler = Scheduler::new(queue, task); /// # /* - /// let scheduler = { /* A `Scheduler`. */ }; + /// let mut scheduler = { /* A `Scheduler`. */ }; /// # */ /// # /// /// // Set a custom cancellation token. /// let token = CancellationToken::new(); - /// scheduler.shutdown_token(token); + /// scheduler.set_shutdown_token(token); /// # Ok::<(), Box>(()) /// # }); /// # } /// ``` - pub fn shutdown_token(mut self, shutdown_token: CancellationToken) -> Self { + pub fn set_shutdown_token(&mut self, shutdown_token: CancellationToken) { self.shutdown_token = shutdown_token; - self } /// Cancels the shutdown token causing the scheduler to exit. diff --git a/src/worker.rs b/src/worker.rs index 4209a80..d2bd052 100644 --- a/src/worker.rs +++ b/src/worker.rs @@ -271,21 +271,20 @@ impl Worker { /// # .build() /// # .await?; /// # let task = ExampleTask; - /// # let worker = Worker::new(queue, task); + /// # let mut worker = Worker::new(queue, task); /// # /* - /// let worker = { /* A `Worker`. */ }; + /// let mut worker = { /* A `Worker`. */ }; /// # */ /// # /// /// // Set a fixed concurrency limit. - /// worker.concurrency_limit(32); + /// worker.set_concurrency_limit(32); /// # Ok::<(), Box>(()) /// # }); /// # } /// ``` - pub fn concurrency_limit(mut self, concurrency_limit: usize) -> Self { + pub fn set_concurrency_limit(&mut self, concurrency_limit: usize) { self.concurrency_limit = concurrency_limit; - self } /// Sets the shutdown token. @@ -320,22 +319,21 @@ impl Worker { /// # .build() /// # .await?; /// # let task = ExampleTask; - /// # let worker = Worker::new(queue, task); + /// # let mut worker = Worker::new(queue, task); /// # /* - /// let worker = { /* A `Worker`. */ }; + /// let mut worker = { /* A `Worker`. */ }; /// # */ /// # /// /// // Set a custom cancellation token. /// let token = CancellationToken::new(); - /// worker.shutdown_token(token); + /// worker.set_shutdown_token(token); /// # Ok::<(), Box>(()) /// # }); /// # } /// ``` - pub fn shutdown_token(mut self, shutdown_token: CancellationToken) -> Self { + pub fn set_shutdown_token(&mut self, shutdown_token: CancellationToken) { self.shutdown_token = shutdown_token; - self } /// Cancels the shutdown token and begins a graceful shutdown of in-progress