Rename Runner to Queue?

[mre]

I was thinking about a better name for Runner, since it caused some confusion.
Here's my proposal:

Main Type

Runner → Queue
RunnerHandle → QueueHandle

Method Names:

Runner::new() → Queue::new()
runner.start() → queue.start()
handle.wait_for_shutdown() → handle.wait_for_shutdown() // keep as-is
.configure_queue("emails", |queue| ...) → .configure_queue("emails", |config| ...)
.shutdown_when_queue_empty() → .shutdown_when_empty()
.configure_default_queue() → .configure_queue(DEFAULT_QUEUE, ...)

Usage Example

  use workers::{Queue, BackgroundJob, DEFAULT_QUEUE};

  // Create a queue system
  let queue = Queue::new(pool, context)
      .register_job_type::<EmailJob>()
      .register_job_type::<PaymentJob>()
      .configure_queue("emails", |config| {
          config.num_workers(4)
                .archive_completed_jobs(true)
      })
      .configure_queue("payments", |config| {
          config.num_workers(2)
                .priority_processing(true)
      });

  // Start processing
  let handle = queue.start();
  handle.wait_for_shutdown().await;

Alternatives

• Supervisor
• Manager

My hope is that this makes the API read naturally: "Create a queue, configure its workers, start processing jobs."

@M3t0r, wdyt?

[tirimia]

Queue makes no sense here, the method Queue::configure_queue sounds quite weird.
Supervisor makes it sound like it's a BEAM process, which usually takes care to restart its subprocesses, which is also not the case here.
Manager would work as QueueManager though!

[mre]

The more I think of it, the more I like Runner. =)
It's not great, but it's short and memorable. But I can see how runner and worker might be ambiguous. Naming is hard. Open for comments.

[M3t0r]

Usuaually I'd call this main struct the same name as the crate. But then it would be called Workers and that might be more confusing. Calling it Config would be my next approach, but that isn't true...

I think WorkerManager or QueueManager would work well.

[mre]

I think we'll stick to runner for the time being. Not 100% happy with any of the names so far, sorry.