Skip to main content

GoalStatus

Enum GoalStatus 

Source
#[repr(i8)]
pub enum GoalStatus { Unknown = 0, Accepted = 1, Executing = 2, Canceling = 3, Succeeded = 4, Canceled = 5, Aborted = 6, }
Expand description

Goal status states

These states match action_msgs/msg/GoalStatus from ROS 2. A goal progresses through these states during its lifecycle.

Variants§

§

Unknown = 0

Status has not been set

§

Accepted = 1

Goal has been accepted and is awaiting execution

§

Executing = 2

Goal is currently being executed

§

Canceling = 3

Goal is in the process of being canceled

§

Succeeded = 4

Goal completed successfully

§

Canceled = 5

Goal was canceled before completion

§

Aborted = 6

Goal was aborted due to an error

Implementations§

Source§

impl GoalStatus

Source

pub fn is_terminal(&self) -> bool

Check if the goal is in a terminal state (completed, canceled, or aborted)

Source

pub fn is_active(&self) -> bool

Check if the goal is still active (accepted, executing, or canceling)

Source

pub fn from_i8(value: i8) -> Option<GoalStatus>

Convert from i8 value

Trait Implementations§

Source§

impl Clone for GoalStatus

Source§

fn clone(&self) -> GoalStatus

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 GoalStatus

Source§

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

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

impl Default for GoalStatus

Source§

fn default() -> GoalStatus

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

impl Deserialize for GoalStatus

Source§

fn deserialize(reader: &mut CdrReader<'_>) -> Result<GoalStatus, DeserError>

Deserialize a value from the CDR reader
Source§

impl Display for GoalStatus

Source§

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

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

impl Hash for GoalStatus

Source§

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

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 GoalStatus

Source§

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

Source§

fn serialize(&self, writer: &mut CdrWriter<'_>) -> Result<(), SerError>

Serialize this value to the CDR writer
Source§

impl Copy for GoalStatus

Source§

impl Eq for GoalStatus

Source§

impl StructuralPartialEq for GoalStatus

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.