Skip to main content

ActionClientCore

Struct ActionClientCore 

Source
pub struct ActionClientCore<const GOAL_BUF: usize = { crate::config::DEFAULT_RX_BUF_SIZE }, const RESULT_BUF: usize = { crate::config::DEFAULT_RX_BUF_SIZE }, const FEEDBACK_BUF: usize = { crate::config::DEFAULT_RX_BUF_SIZE }> { /* private fields */ }
Expand description

Type-agnostic action client core handling the raw-bytes protocol.

The typed ActionClient wraps this and adds serialization/deserialization at the boundary.

Trait Implementations§

Source§

impl<const GOAL_BUF: usize, const RESULT_BUF: usize, const FEEDBACK_BUF: usize> ActionClientCoreFfi for ActionClientCore<GOAL_BUF, RESULT_BUF, FEEDBACK_BUF>

Source§

fn is_server_ready(&self) -> bool

The FFI entry point; see ActionClientCore::is_server_ready in action_core.rs.
Source§

fn server_readiness(&self) -> Result<bool, TransportError>

The FFI entry point; see ActionClientCore::server_readiness in action_core.rs.
Source§

fn new( send_goal_client: RmwServiceClient, cancel_goal_client: RmwServiceClient, get_result_client: RmwServiceClient, feedback_subscriber: RmwSubscriber, ) -> Self

The FFI entry point; see ActionClientCore::new in action_core.rs.
Source§

fn send_goal_raw(&mut self, goal_cdr: &[u8]) -> Result<GoalUuid, NodeError>

The FFI entry point; see ActionClientCore::send_goal_raw in action_core.rs.
Source§

fn try_recv_feedback_raw( &mut self, ) -> Result<Option<(GoalUuid, usize)>, NodeError>

The FFI entry point; see ActionClientCore::try_recv_feedback_raw in action_core.rs.
Source§

fn send_cancel_request(&mut self, goal_id: &GoalUuid) -> Result<(), NodeError>

The FFI entry point; see ActionClientCore::send_cancel_request in action_core.rs.
Source§

fn send_cancel_request_stamped( &mut self, goal_id: &GoalUuid, stamp_sec: i32, stamp_nanosec: u32, ) -> Result<i64, NodeError>

The FFI entry point; see ActionClientCore::send_cancel_request_stamped in action_core.rs.
Source§

fn send_get_result_request( &mut self, goal_id: &GoalUuid, ) -> Result<(), NodeError>

The FFI entry point; see ActionClientCore::send_get_result_request in action_core.rs.
Source§

fn register_goal_response_waker(&self, waker: &Waker) -> bool

The FFI entry point; see ActionClientCore::register_goal_response_waker in action_core.rs.
Source§

fn register_cancel_response_waker(&self, waker: &Waker) -> bool

The FFI entry point; see ActionClientCore::register_cancel_response_waker in action_core.rs.
Source§

fn register_result_waker(&self, waker: &Waker) -> bool

The FFI entry point; see ActionClientCore::register_result_waker in action_core.rs.
Source§

fn register_feedback_waker(&self, waker: &Waker) -> bool

The FFI entry point; see ActionClientCore::register_feedback_waker in action_core.rs.
Source§

fn try_recv_cancel_reply(&mut self) -> Result<Option<usize>, NodeError>

The FFI entry point; see ActionClientCore::try_recv_cancel_reply in action_core.rs.
Source§

fn try_recv_cancel_reply_for( &mut self, ) -> Result<Option<(usize, GoalUuid)>, NodeError>

The FFI entry point; see ActionClientCore::try_recv_cancel_reply_for in action_core.rs.
Source§

fn try_recv_cancel_reply_seq( &mut self, ) -> Result<Option<(usize, i64, GoalUuid)>, NodeError>

The FFI entry point; see ActionClientCore::try_recv_cancel_reply_seq in action_core.rs.
Source§

fn try_recv_get_result_reply(&mut self) -> Result<Option<usize>, NodeError>

The FFI entry point; see ActionClientCore::try_recv_get_result_reply in action_core.rs.
Source§

fn try_recv_get_result_reply_for( &mut self, ) -> Result<Option<(usize, GoalUuid)>, NodeError>

The FFI entry point; see ActionClientCore::try_recv_get_result_reply_for in action_core.rs.
Source§

fn try_recv_send_goal_reply(&mut self) -> Result<Option<usize>, NodeError>

The FFI entry point; see ActionClientCore::try_recv_send_goal_reply in action_core.rs.
Source§

fn try_recv_send_goal_reply_for( &mut self, ) -> Result<Option<(usize, GoalUuid)>, NodeError>

The FFI entry point; see ActionClientCore::try_recv_send_goal_reply_for in action_core.rs.
Source§

fn forget_send_goal(&mut self, goal_id: &GoalUuid) -> bool

The FFI entry point; see ActionClientCore::forget_send_goal in action_core.rs.
Source§

fn forget_get_result(&mut self, goal_id: &GoalUuid) -> bool

The FFI entry point; see ActionClientCore::forget_get_result in action_core.rs.
Source§

fn forget_cancel(&mut self, goal_id: &GoalUuid) -> bool

The FFI entry point; see ActionClientCore::forget_cancel in action_core.rs.
Source§

fn result_buffer_ref(&self) -> &[u8] ⓘ

The FFI entry point; see ActionClientCore::result_buffer_ref in action_core.rs.
Source§

fn feedback_buffer_ref(&self) -> &[u8] ⓘ

The FFI entry point; see ActionClientCore::feedback_buffer_ref in action_core.rs.
Source§

fn goal_counter(&self) -> u64

The FFI entry point; see ActionClientCore::goal_counter in action_core.rs.

Auto Trait Implementations§

§

impl<const GOAL_BUF: usize = { crate::config::DEFAULT_RX_BUF_SIZE }, const RESULT_BUF: usize = { crate::config::DEFAULT_RX_BUF_SIZE }, const FEEDBACK_BUF: usize = { crate::config::DEFAULT_RX_BUF_SIZE }> !Freeze for ActionClientCore<GOAL_BUF, RESULT_BUF, FEEDBACK_BUF>

§

impl<const GOAL_BUF: usize = { crate::config::DEFAULT_RX_BUF_SIZE }, const RESULT_BUF: usize = { crate::config::DEFAULT_RX_BUF_SIZE }, const FEEDBACK_BUF: usize = { crate::config::DEFAULT_RX_BUF_SIZE }> !RefUnwindSafe for ActionClientCore<GOAL_BUF, RESULT_BUF, FEEDBACK_BUF>

§

impl<const GOAL_BUF: usize = { crate::config::DEFAULT_RX_BUF_SIZE }, const RESULT_BUF: usize = { crate::config::DEFAULT_RX_BUF_SIZE }, const FEEDBACK_BUF: usize = { crate::config::DEFAULT_RX_BUF_SIZE }> !Send for ActionClientCore<GOAL_BUF, RESULT_BUF, FEEDBACK_BUF>

§

impl<const GOAL_BUF: usize = { crate::config::DEFAULT_RX_BUF_SIZE }, const RESULT_BUF: usize = { crate::config::DEFAULT_RX_BUF_SIZE }, const FEEDBACK_BUF: usize = { crate::config::DEFAULT_RX_BUF_SIZE }> !Sync for ActionClientCore<GOAL_BUF, RESULT_BUF, FEEDBACK_BUF>

§

impl<const GOAL_BUF: usize, const RESULT_BUF: usize, const FEEDBACK_BUF: usize> Unpin for ActionClientCore<GOAL_BUF, RESULT_BUF, FEEDBACK_BUF>

§

impl<const GOAL_BUF: usize, const RESULT_BUF: usize, const FEEDBACK_BUF: usize> UnsafeUnpin for ActionClientCore<GOAL_BUF, RESULT_BUF, FEEDBACK_BUF>

§

impl<const GOAL_BUF: usize, const RESULT_BUF: usize, const FEEDBACK_BUF: usize> UnwindSafe for ActionClientCore<GOAL_BUF, RESULT_BUF, FEEDBACK_BUF>

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> 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, 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.