Struct rustdds::dds::Topic

pub struct Topic { /* private fields */ }

DDS Topic

DDS Specification, Section 2.2.1.2 Conceptual outline:

Topic objects conceptually fit between publications and subscriptions. Publications must be known in such a way that subscriptions can refer to them unambiguously. A Topic is meant to fulfill that purpose: it associates a name (unique in the > domain), a data-type, and QoS related to the data itself.

Topics can be created (or found) using a DomainParticipant.

Examples

use rustdds::dds::DomainParticipant;
use rustdds::dds::qos::QosPolicyBuilder;
use rustdds::dds::Topic;
use rustdds::dds::data_types::TopicKind;

let domain_participant = DomainParticipant::new(0).unwrap();
let qos = QosPolicyBuilder::new().build();
let topic = domain_participant
      .create_topic("some_topic".to_string(), "SomeType".to_string(), &qos, TopicKind::WithKey)
      .unwrap();

Implementations

impl Topic

pub fn kind(&self) -> TopicKind

Gets Topics TopicKind

Examples

use rustdds::dds::data_types::TopicKind;

let topic = domain_participant
    .create_topic("some_topic".to_string(), "SomeType".to_string(), &qos, TopicKind::WithKey)
    .unwrap();
assert_eq!(topic.kind(), TopicKind::WithKey);

Trait Implementations

impl Clone for Topic

fn clone(&self) -> Topic

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Topic

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

Formats the value using the given formatter.

impl HasQoSPolicy for Topic

fn qos(&self) -> QosPolicies

impl PartialEq<Topic> for Topic

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TopicDescription for Topic

Implements some default topic interfaces functions defined in DDS spec

fn participant(&self) -> Option<DomainParticipant>

Gets DomainParticipant if it is still alive.

fn get_type(&self) -> TypeDesc

Gets type description of this Topic

fn name(&self) -> String

Gets name of this topic