Struct fisher_processor::ProcessorApi

pub struct ProcessorApi<S: ScriptsRepositoryTrait> { /* fields omitted */ }

This struct allows you to interact with a running processor.

Trait Implementations

impl<S: Debug + ScriptsRepositoryTrait> Debug for ProcessorApi<S>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<S: Clone + ScriptsRepositoryTrait> Clone for ProcessorApi<S>

fn clone(&self) -> ProcessorApi<S>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S: ScriptsRepositoryTrait> ProcessorApiTrait<S> for ProcessorApi<S>

fn queue(
    &self,
    job: <S as ScriptsRepositoryTrait>::Job,
    priority: isize
) -> Result<()>

Queue a new job into the processor.

fn health_details(&self) -> Result<HealthDetails>

Get some insights about the health of the processor.

fn cleanup(&self) -> Result<()>

Execute periodic cleanup tasks on the processor.

fn lock(&self) -> Result<()>

Lock the processor, preventing new jobs to be run.

fn unlock(&self) -> Result<()>

Unlock the processor, allowing new jobs to be run.