Struct Topic 

pub struct Topic<'domain, 'participant, T>
where
    T: Topicable,
{ /* private fields */ }

A typed communication channel.

A Topic binds a name to a data type T within a Participant. Writers and Readers are created against a topic and only match each other when they share the same topic name and compatible type and QoS.

Use Topic::new for simple construction or Topic::builder for QoS and listener configuration.

Implementations

impl<'d, 'p, T> Topic<'d, 'p, T>

where T: Topicable,

pub fn new(participant: &'p Participant<'d>, topic_name: &str) -> Result<Self>

Creates a new Topic with the given name under participant using default QoS and no listener.

The topic name identifies the communication channel. Writers and readers match when they share the same name and compatible type.

Errors

Returns an Error if topic fails to create.

Examples

use cyclonedds::Topic;

let topic = Topic::<Data>::new(&participant, "MyTopic")?;

pub const fn builder<'q, 'n>( participant: &'p Participant<'d>, topic_name: &'n str, ) -> TopicBuilder<'d, 'p, 'q, 'n, T>

Returns a TopicBuilder for constructing a topic with custom QoS or a listener.

Examples

use cyclonedds::Topic;

let topic = Topic::<Data>::builder(&participant, "MyTopic").build()?;

pub fn set_listener<L>(&mut self, listener: L) -> Result<()>

where T: Serialize + DeserializeOwned + Clone + Default, L: AsRef<TopicListener<T>>,

Sets the TopicListener on this topic, replacing any previously set listener.

Errors

Returns an Error if the topic fails to set the listener.

Examples

use cyclonedds::listener::TopicListener;

let mut topic = Topic::<Data>::new(&participant, "MyTopic")?;
topic.set_listener(TopicListener::new().with_inconsistent_topic(|_, status| {
    println!("inconsistent topic: {status:?}");
}))?;

pub fn unset_listener(&mut self) -> Result<()>

Removes the listener from this topic.

Errors

Returns an Error if the topic fails to unset the listener.

Examples

let mut topic = Topic::<Data>::new(&participant, "MyTopic")?;
topic.unset_listener()?;

pub fn with_listener<L>(self, listener: L) -> Result<Self>

where T: Serialize + DeserializeOwned + Clone + Default, L: AsRef<TopicListener<T>>,

Sets the TopicListener on this topic, consuming and returning self.

Errors

Returns an Error if the topic fails to set the listener.

Examples

use cyclonedds::listener::TopicListener;

let topic = Topic::<Data>::new(&participant, "MyTopic")?.with_listener(TopicListener::new())?;

Trait Implementations

impl<'domain, 'participant, T> Debug for Topic<'domain, 'participant, T>

where T: Topicable + Debug,

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

Formats the value using the given formatter.

impl<T> Drop for Topic<'_, '_, T>

where T: Topicable,

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T: Topicable> Entity for Topic<'_, '_, T>

fn id(&self) -> EntityId

Returns the EntityId of this entity.

fn instance_handle(&self) -> Result<InstanceHandle>

Returns the InstanceHandle of this entity.

fn status_changes(&self) -> Result<Status>

Returns the set of status flags that have changed since they were last read or taken.

fn take_status(&self, mask: Option<Status>) -> Result<Status>

Takes and clears the status flags matching mask, or all flags if mask is None.

fn read_status(&self, mask: Option<Status>) -> Result<Status>

Reads the status flags matching mask without clearing them, or all flags if mask is None.

fn status_mask(&self) -> Result<Status>

Returns the status mask enabled on the entity.

fn set_status_mask(&self, mask: Status) -> Result<()>

Sets and enables a status mask on the entity.