Struct rustdds::dds::no_key::DataWriter

source ·
pub struct DataWriter<D, SA: SerializerAdapter<D> = CDRSerializerAdapter<D>> { /* private fields */ }
Expand description

DDS DataWriter for no key topics

§Examples

use serde::{Serialize, Deserialize};
use rustdds::*;
use rustdds::no_key::DataWriter;
use rustdds::serialization::CDRSerializerAdapter;

let domain_participant = DomainParticipant::new(0).unwrap();
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

#[derive(Serialize, Deserialize, Debug)]
struct SomeType {}

// NoKey is important
let topic = domain_participant.create_topic("some_topic".to_string(), "SomeType".to_string(), &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(&topic, None);

Implementations§

source§

impl<D, SA> DataWriter<D, SA>
where SA: SerializerAdapter<D>,

source

pub fn write( &self, data: D, source_timestamp: Option<Timestamp> ) -> WriteResult<(), D>

Writes single data instance to a topic.

§Examples
let domain_participant = DomainParticipant::new(0).unwrap();
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

// NoKey is important
let topic = domain_participant.create_topic("some_topic".to_string(), "SomeType".to_string(), &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(&topic, None).unwrap();

let some_data = SomeType {};
data_writer.write(some_data, None).unwrap();
source

pub fn write_with_options( &self, data: D, write_options: WriteOptions ) -> WriteResult<SampleIdentity, D>

source

pub fn wait_for_acknowledgments( &self, max_wait: Duration ) -> WriteResult<bool, ()>

Waits for all acknowledgements to finish

§Examples
let domain_participant = DomainParticipant::new(0).unwrap();
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

// NoKey is important
let topic = domain_participant.create_topic("some_topic".to_string(), "SomeType".to_string(), &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(&topic, None).unwrap();

data_writer.wait_for_acknowledgments(Duration::from_millis(100));
source

pub fn topic(&self) -> &Topic

Topic this DataWriter is connected to.

§Examples
let domain_participant = DomainParticipant::new(0).unwrap();
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

// NoKey is important
let topic = domain_participant.create_topic("some_topic".to_string(), "SomeType".to_string(), &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(&topic, None).unwrap();

assert_eq!(&topic, data_writer.topic());
source

pub fn publisher(&self) -> &Publisher

Publisher this DataWriter is connected to.

§Examples
let domain_participant = DomainParticipant::new(0).unwrap();
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

// NoKey is important
let topic = domain_participant.create_topic("some_topic".to_string(), "SomeType".to_string(), &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(&topic, None).unwrap();

assert_eq!(&publisher, data_writer.publisher());
source

pub fn assert_liveliness(&self) -> WriteResult<(), ()>

Manually asserts liveliness if QoS agrees

§Examples
let domain_participant = DomainParticipant::new(0).unwrap();
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

// NoKey is important
let topic = domain_participant.create_topic("some_topic".to_string(), "SomeType".to_string(), &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(&topic, None).unwrap();

data_writer.assert_liveliness();
source

pub fn get_matched_subscriptions(&self) -> Vec<SubscriptionBuiltinTopicData>

Unimplemented. Do not use.

§Examples
let domain_participant = DomainParticipant::new(0).unwrap();
let qos = QosPolicyBuilder::new().build();
let publisher = domain_participant.create_publisher(&qos).unwrap();

// NoKey is important
let topic = domain_participant.create_topic("some_topic".to_string(), "SomeType".to_string(), &qos, TopicKind::NoKey).unwrap();
let data_writer = publisher.create_datawriter_no_key::<SomeType, CDRSerializerAdapter<_>>(topic, None).unwrap();

for sub in data_writer.get_matched_subscriptions().iter() {
  // handle subscriptions
}
source§

impl<D, SA> DataWriter<D, SA>
where SA: SerializerAdapter<D>,

source

pub async fn async_write( &self, data: D, source_timestamp: Option<Timestamp> ) -> WriteResult<(), D>

source

pub async fn async_write_with_options( &self, data: D, write_options: WriteOptions ) -> WriteResult<SampleIdentity, D>

source

pub async fn async_wait_for_acknowledgments(&self) -> WriteResult<bool, ()>

Trait Implementations§

source§

impl<D, SA: SerializerAdapter<D>> HasQoSPolicy for DataWriter<D, SA>

source§

impl<D, SA: SerializerAdapter<D>> RTPSEntity for DataWriter<D, SA>

source§

fn guid(&self) -> GUID

source§

fn entity_id(&self) -> EntityId

source§

fn guid_prefix(&self) -> GuidPrefix

source§

impl<'a, D, SA> StatusEvented<'a, DataWriterStatus, StatusReceiverStream<'a, DataWriterStatus>> for DataWriter<D, SA>
where SA: SerializerAdapter<D>,

WARNING! UNTESTED

Auto Trait Implementations§

§

impl<D, SA = CDRSerializerAdapter<D>> !Freeze for DataWriter<D, SA>

§

impl<D, SA = CDRSerializerAdapter<D>> !RefUnwindSafe for DataWriter<D, SA>

§

impl<D, SA> Send for DataWriter<D, SA>
where D: Send, SA: Send,

§

impl<D, SA> Sync for DataWriter<D, SA>
where D: Sync, SA: Sync,

§

impl<D, SA> Unpin for DataWriter<D, SA>
where D: Unpin, SA: Unpin,

§

impl<D, SA = CDRSerializerAdapter<D>> !UnwindSafe for DataWriter<D, SA>

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

§

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

§

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.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V