Struct r2r::ActionClientGoal
source · pub struct ActionClientGoal<T>where
T: WrappedActionTypeSupport,{
pub uuid: Uuid,
/* private fields */
}Expand description
Action client goal handle
This can be used to cancel goals and query the status of goals.
Fields§
§uuid: UuidImplementations§
source§impl<T> ActionClientGoal<T>where
T: WrappedActionTypeSupport + 'static,
impl<T> ActionClientGoal<T>where
T: WrappedActionTypeSupport + 'static,
sourcepub fn get_status(&self) -> Result<GoalStatus>
pub fn get_status(&self) -> Result<GoalStatus>
Get the current status of this goal.
sourcepub fn cancel(&self) -> Result<impl Future<Output = Result<()>>>
pub fn cancel(&self) -> Result<impl Future<Output = Result<()>>>
Send a cancel request for this goal to the server.
If the server accepts and completes the request, the future completes without error. Otherwise, one of these errors can be returned:
GoalCancelRejectedGoalCancelUnknownGoalIDGoalCancelAlreadyTerminated
Trait Implementations§
source§impl<T> Clone for ActionClientGoal<T>where
T: WrappedActionTypeSupport + Clone,
impl<T> Clone for ActionClientGoal<T>where
T: WrappedActionTypeSupport + Clone,
source§fn clone(&self) -> ActionClientGoal<T>
fn clone(&self) -> ActionClientGoal<T>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreimpl<T> Send for ActionClientGoal<T>where
T: WrappedActionTypeSupport,
Auto Trait Implementations§
impl<T> Freeze for ActionClientGoal<T>
impl<T> RefUnwindSafe for ActionClientGoal<T>
impl<T> Sync for ActionClientGoal<T>where
<T as WrappedActionTypeSupport>::Feedback: Send,
<T as WrappedActionTypeSupport>::Result: Send,
impl<T> Unpin for ActionClientGoal<T>
impl<T> UnwindSafe for ActionClientGoal<T>
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> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit)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