Skip to main content

JobSpec

Struct JobSpec 

Source
pub struct JobSpec { /* private fields */ }
Expand description

Schedule for a job submitted via ActorSystem::run_job.

  • max_iter — cap on iterations. None = run forever (until abort_job or the actor disappears). Some(n) exits after n successful iterations.
  • interval — wait between iterations. None is a single-shot job (max_iter is forced to Some(1) in new).
  • start_at — earliest moment the first iteration may run. If in the past, the job starts immediately. If in the future, the job loop sleeps until then before the first dispatch.

Implementations§

Source§

impl JobSpec

Source

pub fn new( max_iter: Option<usize>, interval: Option<Duration>, start_at: SystemTime, ) -> Self

Build a JobSpec. If interval is None, max_iter is forced to Some(1) regardless of the value you pass — single-shot jobs always run exactly once.

Source

pub fn max_iter(&self) -> Option<usize>

Maximum number of iterations, or None for infinite.

Source

pub fn start_at(&self) -> SystemTime

Earliest moment the first iteration may run.

Source

pub fn interval(&self) -> Option<Duration>

Time between iterations, or None for single-shot.

Trait Implementations§

Source§

impl Clone for JobSpec

Source§

fn clone(&self) -> JobSpec

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for JobSpec

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for JobSpec

Source§

fn default() -> Self

Single-shot, runs immediately. Equivalent to JobSpec::new(Some(1), None, SystemTime::now()).

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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> MaybeCodec for T
where T: ?Sized,