pub struct Phase { /* private fields */ }Expand description
Immutable nonempty execution phase and renderer section.
Implementations§
Source§impl Phase
impl Phase
Sourcepub fn builder(id: impl Into<PhaseId>, label: impl Into<String>) -> PhaseBuilder
pub fn builder(id: impl Into<PhaseId>, label: impl Into<String>) -> PhaseBuilder
Begins declaring a phase. Tasks must be added before PhaseBuilder::build.
Sourcepub const fn max_active_tasks(&self) -> usize
pub const fn max_active_tasks(&self) -> usize
Returns the phase-local concurrent workload ceiling.
Sourcepub const fn prepared_task_queue_capacity(&self) -> usize
pub const fn prepared_task_queue_capacity(&self) -> usize
Returns the prepared-but-not-running workload ceiling.
Sourcepub const fn delay_per_task(&self) -> Option<Duration>
pub const fn delay_per_task(&self) -> Option<Duration>
Returns the optional minimum interval between consecutive task starts.
Sourcepub const fn task_timeout(&self) -> Option<Duration>
pub const fn task_timeout(&self) -> Option<Duration>
Returns the optional elapsed-time limit for each running task.
Sourcepub const fn deadline_after(&self) -> Option<Duration>
pub const fn deadline_after(&self) -> Option<Duration>
Returns the optional phase deadline measured from phase execution start.
Sourcepub fn dependencies(&self) -> &[PhaseId]
pub fn dependencies(&self) -> &[PhaseId]
Returns declared predecessor phases in declaration order.
Sourcepub const fn failure_policy(&self) -> PhaseFailurePolicy
pub const fn failure_policy(&self) -> PhaseFailurePolicy
Returns the behavior selected for the first workload failure.
Sourcepub const fn requires_confirmation(&self) -> bool
pub const fn requires_confirmation(&self) -> bool
Reports whether successful completion requires confirmation before the next selected phase may start.
Sourcepub fn unique_task_matching(
&self,
selector: &TaskSelector,
) -> Result<&Task, StudyError>
pub fn unique_task_matching( &self, selector: &TaskSelector, ) -> Result<&Task, StudyError>
Returns the sole task matching an exact partial selector.
Trait Implementations§
Auto Trait Implementations§
impl !RefUnwindSafe for Phase
impl !Sync for Phase
impl !UnwindSafe for Phase
impl Freeze for Phase
impl Send for Phase
impl Unpin for Phase
impl UnsafeUnpin for Phase
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more