Struct ros2_client::Subscription

pub struct Subscription<M> { /* private fields */ }

A ROS2 Subscription

Corresponds to a (simplified) DataReader in DDS

Implementations

impl<M> Subscription<M>

where M: 'static,

pub fn take_seed<'de, S>(&self, seed: S) -> ReadResult<Option<(M, MessageInfo)>>

where S: DeserializeSeed<'de, Value = M> + Clone, M: 'static,

pub fn async_stream_seed<'a, 'de, S>( &'a self, seed: S ) -> impl FusedStream<Item = ReadResult<(M, MessageInfo)>> + 'a

where S: DeserializeSeed<'de, Value = M> + Clone + 'a, M: 'static,

impl<M: 'static + DeserializeOwned> Subscription<M>

pub fn take(&self) -> ReadResult<Option<(M, MessageInfo)>>

pub async fn async_take(&self) -> ReadResult<(M, MessageInfo)>

pub fn async_stream( &self ) -> impl FusedStream<Item = ReadResult<(M, MessageInfo)>> + '_

impl<M> Subscription<M>

where M: 'static,

pub fn guid(&self) -> GUID

pub fn gid(&self) -> Gid

pub fn get_publisher_count(&self, my_node: &Node) -> usize

Returns the count of currently matched Publishers.

my_node must be the Node that created this Subscription, or the result is undefined.

pub async fn wait_for_publisher(&self, my_node: &Node)

Waits until there is at least one matched publisher on this topic, possibly forever.

my_node must be the Node that created this Subscription, or the length of the wait is undefined.

Trait Implementations

impl<D> Evented for Subscription<D>

where D: DeserializeOwned,

fn register( &self, poll: &Poll, token: Token, interest: Ready, opts: PollOpt ) -> Result<()>

Register self with the given Poll instance.

fn reregister( &self, poll: &Poll, token: Token, interest: Ready, opts: PollOpt ) -> Result<()>

Re-register self with the given Poll instance.

fn deregister(&self, poll: &Poll) -> Result<()>

Deregister self from the given Poll instance