Skip to main content

Status

Enum Status 

Source
pub enum Status {
    Initializing,
    Idle,
    Running,
    Paused,
    AwaitingApproval,
    Completed,
    Error,
    Aborted,
}
Expand description

Component execution status.

Represents the current state of a component or child.

§State Categories

CategoryStatesCan Receive Work
ActiveRunning, AwaitingApprovalYes (in progress)
ReadyIdleYes
TerminalCompleted, Error, AbortedNo
SetupInitializing, PausedNo (temporarily)

Variants§

§

Initializing

Component is initializing.

Setup phase before accepting work.

§

Idle

Component is idle, waiting for work.

Ready to accept requests.

§

Running

Component is actively processing.

§

Paused

Component is paused (can resume).

Temporarily stopped, can continue with Resume signal.

§

AwaitingApproval

Component is waiting for HIL approval.

Blocked on human decision.

§

Completed

Component completed successfully.

Terminal state - no more work will be done.

§

Error

Component encountered an error.

Terminal state - may be recoverable with retry.

§

Aborted

Component was aborted (by signal).

Terminal state - explicitly stopped.

Implementations§

Source§

impl Status

Source

pub fn is_active(&self) -> bool

Returns true if the component is actively working.

Active states: Running, AwaitingApproval

§Example
use orcs_component::Status;

assert!(Status::Running.is_active());
assert!(Status::AwaitingApproval.is_active());
assert!(!Status::Idle.is_active());
Source

pub fn is_terminal(&self) -> bool

Returns true if the component is in a terminal state.

Terminal states: Completed, Error, Aborted

§Example
use orcs_component::Status;

assert!(Status::Completed.is_terminal());
assert!(Status::Error.is_terminal());
assert!(Status::Aborted.is_terminal());
assert!(!Status::Running.is_terminal());
Source

pub fn is_ready(&self) -> bool

Returns true if the component can accept new work.

Ready state: Idle

§Example
use orcs_component::Status;

assert!(Status::Idle.is_ready());
assert!(!Status::Running.is_ready());

Trait Implementations§

Source§

impl Clone for Status

Source§

fn clone(&self) -> Status

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 Status

Source§

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

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

impl Default for Status

Source§

fn default() -> Status

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

impl<'de> Deserialize<'de> for Status

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for Status

Source§

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

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

impl Hash for Status

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for Status

Source§

fn eq(&self, other: &Status) -> 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 Serialize for Status

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl Copy for Status

Source§

impl Eq for Status

Source§

impl StructuralPartialEq for Status

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,