Skip to main content

Status

arora_behavior::status

Enum Status

pub enum Status {
    Success,
    Failure,
    Running,
}

Expand description

A run’s lifecycle status: still running, or a terminal outcome.

The one status vocabulary a behavior speaks on the value plane — the value an interpreter writes to a run’s status key, and the value the ROS 2 action plane maps to GoalStatus.

Variants§

Success

The behavior finished cleanly.

Failure

The behavior finished in failure (also what a halted run reports — a halted run did not reach its goal).

Running

The behavior is still running; tick it again.

Trait Implementations§

impl AroraType for Status

fn arora_type_id() -> Uuid

The id this type is known by: the id its arora_type carries, and the id a field of this type is referenced by.

fn arora_type() -> Type

This type’s own definition. Nested user-defined types are named by id in the field type references; their definitions are obtained from the registry filled by register_types.

fn register_types(registry: &mut TypeRegistry)

Insert this type and every type it transitively depends on into registry. Idempotent, and safe for types reachable from themselves.

fn arora_type_with_registry() -> (Type, HashMap<Uuid, Type>)

This type’s definition together with a registry holding it and all its dependencies — everything a walk needs to resolve a value of this type.

impl Clone for Status

fn clone(&self) -> Status

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

impl Copy for Status

impl Debug for Status

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

Formats the value using the given formatter. Read more

impl Eq for Status

impl From<Status> for Value

fn from(status: Status) -> Value

Converts to this type from the input type.

impl PartialEq for Status

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl StructuralPartialEq for Status

impl TryFrom<Value> for Status

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

impl Freeze for Status

impl RefUnwindSafe for Status

impl Send for Status

impl Sync for Status

impl Unpin for Status

impl UnsafeUnpin for Status

impl UnwindSafe for Status

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.