Struct PublisherBuilder 

pub struct PublisherBuilder<'a, 'b> { /* private fields */ }

A builder for initializing a Publisher. Returned by the Session::declare_publisher method.

Examples

use zenoh::qos::CongestionControl;

let session = zenoh::open(zenoh::Config::default()).await.unwrap();
let publisher = session
    .declare_publisher("key/expression")
    .congestion_control(CongestionControl::Block)
    .await
    .unwrap();

Implementations

impl PublisherBuilder<'_, '_>

pub fn encoding<T: Into<Encoding>>(self, encoding: T) -> Self

Sets the default Encoding of the payload generated by this publisher.

impl PublisherBuilder<'_, '_>

pub fn congestion_control(self, congestion_control: CongestionControl) -> Self

Changes the CongestionControl to apply when routing the data.

pub fn priority(self, priority: Priority) -> Self

Changes the Priority of the written data.

pub fn express(self, is_express: bool) -> Self

Changes the Express policy to apply when routing the data.

When express is set to true, then the message will not be batched. This usually has a positive impact on latency but a negative impact on throughput.

impl PublisherBuilder<'_, '_>

pub fn allowed_destination(self, destination: Locality) -> Self

Changes the Locality applied when routing the data.

This restricts the matching subscribers that will receive the published data to the ones that have the given Locality.

pub fn reliability(self, reliability: Reliability) -> Self

Available on crate feature unstable only.

Changes the Reliability to apply when routing the data.

This API has been marked as unstable: it works as advertised, but it may be changed in a future release.

NOTE: Currently reliability does not trigger any data retransmission on the wire. It is rather used as a marker on the wire and it may be used to select the best link available (e.g. TCP for reliable data and UDP for best effort data).

Trait Implementations

impl Clone for PublisherBuilder<'_, '_>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, 'b> Debug for PublisherBuilder<'a, 'b>

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

Formats the value using the given formatter.

impl IntoFuture for PublisherBuilder<'_, '_>

type Output = <PublisherBuilder<'_, '_> as Resolvable>::To

The output that the future will produce on completion.

type IntoFuture = Ready<<PublisherBuilder<'_, '_> as Resolvable>::To>

Which kind of future are we turning this into?

fn into_future(self) -> Self::IntoFuture

Creates a future from a value.

impl<'b> Resolvable for PublisherBuilder<'_, 'b>

type To = Result<Publisher<'b>, Box<dyn Error + Send + Sync>>

impl Wait for PublisherBuilder<'_, '_>

fn wait(self) -> <Self as Resolvable>::To

Synchronously execute and wait