Struct coil::Builder

pub struct Builder<Env> { /* fields omitted */ }

Builder pattern struct for the Runner

Implementations

impl<Env: 'static> Builder<Env>

pub fn new(env: Env, executor: impl Spawn + 'static, pg_pool: PgPool) -> Self

Instantiate a new instance of the Builder

pub fn register_job<T: Job + 'static + Send>(self) -> Self

Register a job that hasn't or can't be registered by invoking the register_job! macro

Jobs that include generics must use this function in order to be registered with a runner. Jobs must be registered with every generic that is used. Jobs are available in the format my_function_name::Job.

Example

RunnerBuilder::new(env, executor, conn)
    .register_job::<resize_image::Job<String>>()

Different jobs must be registered with different generics if they exist.

RunnerBuilder::new((), executor, conn)
   .register_job::<resize_image::Job<String>>()
   .register_job::<resize_image::Job<u32>>()
   .register_job::<resize_image::Job<MyStruct>()

pub fn num_threads(self, threads: usize) -> Self

specify the amount of threads to run the threadpool with

pub fn max_tasks(self, max_tasks: usize) -> Self

Specify the maximum tasks to queue in the threadpool at any given time

pub fn on_finish(self, on_finish: impl Fn(i64) + Send + Sync + 'static) -> Self

Provide a hook that runs after a job has finished and all destructors have run the on_finish closure accepts the job ID that finished as an argument

pub fn timeout(self, timeout: Duration) -> Self

Set a timeout in seconds. This timeout is the maximum amount of time coil will wait for a job to begin before returning an error.

pub fn build(self) -> Result<Runner<Env>, Error>

Build the runner