Cron

Struct Cron 

Source
pub struct Cron<'a, D>
where D: Driver + Send + Sync,
{ /* private fields */ }
Expand description

The Cron struct is the main entry point for the library, providing the ability to add and remove jobs.

Implementations§

Source§

impl<'a, D> Cron<'a, D>
where D: Driver + Send + Sync + 'static,

Source

pub async fn new(np: NodePool<D>) -> Arc<Self>

Create a new cron with the given node pool.

Source

pub async fn start(&self) -> Result<(), Error<D>>

Start the cron, blocking the current thread.

Source

pub async fn add_job<F>( &self, job_name: &str, schedule: Schedule, run: F, ) -> Result<(), Error<D>>
where F: 'static + Sync + Send + Fn(),

Add a job to the cron

§Arguments
  • job_name - The unique name of the job
  • schedule - The schedule of the job
  • run - The function to run
Source

pub async fn add_async_job<F, Fut>( &self, job_name: &str, schedule: Schedule, run: F, ) -> Result<(), Error<D>>
where F: 'static + Sync + Send + Fn() -> Fut, Fut: Future<Output = ()> + Send,

Add an async job to the cron

§Arguments
  • job_name - The unique name of the job
  • schedule - The schedule of the job
  • run - The async function to run
Source

pub async fn remove_job(&self, job_name: &str) -> Result<(), Error<D>>

Remove a job from the cron

§Arguments
  • job_name - The unique name of the job

Trait Implementations§

Source§

impl<D> Drop for Cron<'_, D>
where D: Driver + Send + Sync,

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<'a, D> !Freeze for Cron<'a, D>

§

impl<'a, D> !RefUnwindSafe for Cron<'a, D>

§

impl<'a, D> Send for Cron<'a, D>

§

impl<'a, D> Sync for Cron<'a, D>

§

impl<'a, D> Unpin for Cron<'a, D>

§

impl<'a, D> !UnwindSafe for Cron<'a, D>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,