Skip to main content

TaskConstraints

Struct TaskConstraints 

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

Constraints that control how a task’s runs are executed.

Implementations§

Source§

impl TaskConstraints

Source

pub fn new( max_attempts: u32, timeout_secs: Option<u64>, concurrency_key: Option<String>, ) -> Result<Self, TaskConstraintsError>

Creates constraints with validation of invariant-sensitive fields.

Source

pub fn validate(&self) -> Result<(), TaskConstraintsError>

Validates this constraints object against core invariants.

Source

pub fn max_attempts(&self) -> u32

Returns the maximum number of attempts allowed for each run.

Source

pub fn timeout_secs(&self) -> Option<u64>

Returns the optional per-attempt timeout in seconds.

Source

pub fn concurrency_key(&self) -> Option<&str>

Returns the optional concurrency key.

Source

pub fn set_max_attempts( &mut self, max_attempts: u32, ) -> Result<(), TaskConstraintsError>

Sets the attempt cap with invariant validation.

Source

pub fn set_timeout_secs( &mut self, timeout_secs: Option<u64>, ) -> Result<(), TaskConstraintsError>

Sets the optional timeout in seconds.

§Errors

Returns TaskConstraintsError::ZeroTimeout if timeout_secs is Some(0).

Source

pub fn set_concurrency_key( &mut self, concurrency_key: Option<String>, ) -> Result<(), TaskConstraintsError>

Sets the optional concurrency key.

§Errors

Returns TaskConstraintsError::EmptyConcurrencyKey if the key is Some("").

Source

pub fn concurrency_key_hold_policy(&self) -> ConcurrencyKeyHoldPolicy

Returns the concurrency key hold policy.

Source

pub fn set_concurrency_key_hold_policy( &mut self, policy: ConcurrencyKeyHoldPolicy, )

Sets the concurrency key hold policy.

Source

pub fn safety_level(&self) -> SafetyLevel

Returns the safety level classification for this task.

Source

pub fn set_safety_level(&mut self, safety_level: SafetyLevel)

Sets the safety level classification.

Source

pub fn required_capabilities(&self) -> Option<&[String]>

Returns the required executor capabilities, if any.

In v0.x the local executor handles all tasks (this field is ignored). In Sprint 4 (v1.0), only remote actors declaring all listed capabilities will be offered this task.

Source

pub fn with_capabilities( self, caps: Vec<String>, ) -> Result<Self, TaskConstraintsError>

Attaches required capabilities, returning the modified constraints.

The list must be non-empty; an empty vec is rejected at validation.

Trait Implementations§

Source§

impl Clone for TaskConstraints

Source§

fn clone(&self) -> TaskConstraints

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TaskConstraints

Source§

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

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

impl Default for TaskConstraints

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for TaskConstraints

Source§

fn eq(&self, other: &TaskConstraints) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for TaskConstraints

Source§

impl StructuralPartialEq for TaskConstraints

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.