Struct SubscriberBuilder 

pub struct SubscriberBuilder<'domain, 'participant, 'qos> { /* private fields */ }

Builder for Subscriber (accessible via Subscriber::builder).

Implementations

impl<'d, 'p, 'q> SubscriberBuilder<'d, 'p, 'q>

pub const fn new(participant: &'p Participant<'d>) -> Self

Creates a new SubscriberBuilder for the given Participant.

Examples

use cyclonedds::builder::SubscriberBuilder;
use cyclonedds::{Domain, Participant};

let domain = Domain::default();
let participant = Participant::new(&domain)?;
let subscriber_builder = SubscriberBuilder::new(&participant);

pub const fn with_qos(self, qos: &'q QoS) -> Self

Sets the QoS for this subscriber builder.

Examples

use cyclonedds::builder::SubscriberBuilder;
use cyclonedds::qos::policy;
use cyclonedds::{Duration, QoS};

let qos = QoS::new().with_reliability(policy::Reliability::Reliable {
    max_blocking_time: Duration::from_millis(100),
});
let subscriber_builder = SubscriberBuilder::new(&participant).with_qos(&qos);

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

where L: AsRef<SubscriberListener>,

Sets the Listener on this subscriber builder.

Examples

use cyclonedds::Listener;
use cyclonedds::builder::SubscriberBuilder;

let subscriber_builder = SubscriberBuilder::new(&participant).with_listener(Listener::new());

pub fn build(self) -> Result<Subscriber<'d, 'p>>

Builds the Subscriber.

Errors

Returns an Error if the subscriber failed to create.

Examples

use cyclonedds::QoS;
use cyclonedds::builder::SubscriberBuilder;
use cyclonedds::qos::policy;

let qos = QoS::new().with_durability(policy::Durability::TransientLocal);
let subscriber = SubscriberBuilder::new(&participant)
    .with_qos(&qos)
    .build()?;

Trait Implementations

impl<'domain, 'participant, 'qos> Debug for SubscriberBuilder<'domain, 'participant, 'qos>

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

Formats the value using the given formatter.