Skip to main content

GoalStatus

Enum GoalStatus 

Source
#[non_exhaustive]
pub enum GoalStatus { Unknown, Accepted, Executing, Canceling, Succeeded, Canceled, Aborted, }
Expand description

The lifecycle state of an action goal (blueprint §9.4).

The discriminants match ROS 2’s action_msgs/msg/GoalStatus constants exactly, so astrs-ros2 can bridge an action in either direction without a translation table. The AstRS FSM proper is Accepted → Executing → {Succeeded, Aborted, Canceled}; Canceling and Unknown exist for ROS 2 fidelity.

§Examples

use astrs_wire::GoalStatus;

assert_eq!(GoalStatus::Executing.as_i64(), 2);
assert_eq!(GoalStatus::from_i64(4), Some(GoalStatus::Succeeded));
assert!(GoalStatus::Succeeded.is_terminal());
assert!(GoalStatus::Accepted.can_transition_to(GoalStatus::Executing));
assert!(!GoalStatus::Succeeded.can_transition_to(GoalStatus::Executing));

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Unknown

The goal’s state is not known (ROS 2 STATUS_UNKNOWN).

§

Accepted

The server accepted the goal but has not started it (ROS 2 STATUS_ACCEPTED).

§

Executing

The server is executing the goal (ROS 2 STATUS_EXECUTING).

§

Canceling

A cancellation was requested and is being processed (ROS 2 STATUS_CANCELING).

§

Succeeded

The goal completed successfully (ROS 2 STATUS_SUCCEEDED).

§

Canceled

The goal was cancelled (ROS 2 STATUS_CANCELED).

§

Aborted

The goal failed (ROS 2 STATUS_ABORTED).

Implementations§

Source§

impl GoalStatus

Source

pub const ALL: &'static [GoalStatus]

Every status, in discriminant order.

Source

pub const fn as_i64(self) -> i64

The numeric form stored under GOAL_STATUS.

Source

pub const fn from_i64(code: i64) -> Option<GoalStatus>

Parses the numeric form.

Returns None for a code this build does not know, rather than collapsing it to GoalStatus::Unknown — a caller that wants that fallback should say so.

§Examples
use astrs_wire::GoalStatus;

assert_eq!(GoalStatus::from_i64(6), Some(GoalStatus::Aborted));
assert_eq!(GoalStatus::from_i64(7), None);
assert_eq!(GoalStatus::from_i64(-1), None);
Source

pub const fn as_str(self) -> &'static str

A stable, lower-case name.

Source

pub const fn is_terminal(self) -> bool

Whether the goal has reached a final state.

§Examples
use astrs_wire::GoalStatus;

assert!(GoalStatus::Canceled.is_terminal());
assert!(!GoalStatus::Canceling.is_terminal());
Source

pub const fn is_active(self) -> bool

Whether the goal is still in flight.

Source

pub const fn can_transition_to(self, next: GoalStatus) -> bool

Whether next is a legal successor of self in the goal FSM.

Servers use this to reject a status update that would move a goal backwards or out of a terminal state, which is the failure mode that leaves a client waiting forever.

§Examples
use astrs_wire::GoalStatus;

assert!(GoalStatus::Unknown.can_transition_to(GoalStatus::Accepted));
assert!(GoalStatus::Executing.can_transition_to(GoalStatus::Canceling));
assert!(GoalStatus::Canceling.can_transition_to(GoalStatus::Canceled));
assert!(!GoalStatus::Accepted.can_transition_to(GoalStatus::Unknown));
assert!(!GoalStatus::Aborted.can_transition_to(GoalStatus::Aborted));

Trait Implementations§

Source§

impl Clone for GoalStatus

Source§

fn clone(&self) -> GoalStatus

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
Source§

impl Copy for GoalStatus

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 Decode for GoalStatus

Source§

fn decode<__D>(decoder: &mut __D) -> Result<GoalStatus, Error>
where __D: Decoder<Context = ()>,

Decode a value from the given decoder
Source§

impl Default for GoalStatus

Source§

fn default() -> GoalStatus

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

impl<'de> Deserialize<'de> for GoalStatus

Source§

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

Deserialize this value from the given Serde deserializer. Read more
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 Encode for GoalStatus

Source§

fn encode<__E>(&self, encoder: &mut __E) -> Result<(), Error>
where __E: Encoder,

Encode this value into the given encoder
Source§

impl Eq for GoalStatus

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 Ord for GoalStatus

Source§

fn cmp(&self, other: &GoalStatus) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 (const: unstable) · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

fn clamp_to<R>(self, range: R) -> Self
where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)
Restrict a value to a certain range. Read more
Source§

impl PartialEq for GoalStatus

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl PartialOrd for GoalStatus

Source§

fn partial_cmp(&self, other: &GoalStatus) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Serialize for GoalStatus

Source§

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

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

impl StructuralPartialEq for GoalStatus

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

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

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> MaybeDebug for T

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WireDecode for T
where T: Decode,

Source§

fn decode_exact(bytes: &[u8]) -> Result<T, WireError>

Decodes a value that must occupy all of bytes. Read more
Source§

fn decode_prefix(bytes: &[u8]) -> Result<(T, usize), WireError>

Decodes a value from the front of bytes, returning it together with the number of bytes consumed. Read more
Source§

impl<T> WireEncode for T
where T: Encode,

Source§

fn encode_size_hint(&self) -> Result<usize, WireError>

The exact number of bytes WireEncode::encode_presized will produce. Read more
Source§

fn encode_presized(&self, out: &mut Vec<u8>) -> Result<usize, WireError>

Appends the encoded form to out, reserving the exact space first. Read more
Source§

fn encode_to_vec(&self) -> Result<Vec<u8>, WireError>

Encodes into a freshly allocated, exactly-sized Vec<u8>. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more