Struct AdvancedSubscriberBuilder

pub struct AdvancedSubscriberBuilder<'a, 'b, 'c, Handler, const BACKGROUND: bool = false> { /* private fields */ }

The builder of an AdvancedSubscriber, allowing to configure it.

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

Implementations

impl<'a, 'b, 'c> AdvancedSubscriberBuilder<'a, 'b, 'c, DefaultHandler>

pub fn callback<F>( self, callback: F, ) -> AdvancedSubscriberBuilder<'a, 'b, 'c, Callback<Sample>>

where F: Fn(Sample) + Send + Sync + 'static,

Add callback to AdvancedSubscriber.

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

pub fn callback_mut<F>( self, callback: F, ) -> AdvancedSubscriberBuilder<'a, 'b, 'c, Callback<Sample>>

where F: FnMut(Sample) + Send + Sync + 'static,

Add callback to AdvancedSubscriber.

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

Using this guarantees that your callback will never be called concurrently. If your callback is also accepted by the callback method, we suggest you use it instead of callback_mut

pub fn with<Handler>( self, handler: Handler, ) -> AdvancedSubscriberBuilder<'a, 'b, 'c, Handler>

where Handler: IntoHandler<Sample>,

Make the built AdvancedSubscriber an AdvancedSubscriber.

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

impl<'a, 'b, 'c> AdvancedSubscriberBuilder<'a, 'b, 'c, Callback<Sample>>

pub fn background( self, ) -> AdvancedSubscriberBuilder<'a, 'b, 'c, Callback<Sample>, true>

Register the subscriber callback to be run in background until the session is closed.

Background builder doesn’t return a AdvancedSubscriber object anymore.

impl<'a, 'c, Handler, const BACKGROUND: bool> AdvancedSubscriberBuilder<'a, '_, 'c, Handler, BACKGROUND>

pub fn allowed_origin(self, origin: Locality) -> Self

Restrict the matching publications that will be receive by this Subscriber

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

to the ones that have the given [`Locality`](crate::prelude::Locality).

pub fn recovery(self, conf: RecoveryConfig<Configured>) -> Self

Ask for retransmission of detected lost Samples.

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

Retransmission can only be achieved by AdvancedPublishers that enable cache and sample_miss_detection.

pub fn query_timeout(self, query_timeout: Duration) -> Self

Change the timeout to be used for queries (history, retransmission).

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

pub fn history(self, config: HistoryConfig) -> Self

Enable query for historical data.

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

History can only be retransmitted by AdvancedPublishers that enable cache.

pub fn subscriber_detection(self) -> Self

Allow this subscriber to be detected through liveliness.

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

pub fn subscriber_detection_metadata<TryIntoKeyExpr>( self, meta: TryIntoKeyExpr, ) -> Self

where TryIntoKeyExpr: TryInto<KeyExpr<'c>>, <TryIntoKeyExpr as TryInto<KeyExpr<'c>>>::Error: Into<Error>,

A key expression added to the liveliness token key expression.

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

It can be used to convey meta data.

Trait Implementations

impl IntoFuture for AdvancedSubscriberBuilder<'_, '_, '_, Callback<Sample>, true>

type Output = <AdvancedSubscriberBuilder<'_, '_, '_, Callback<Sample>, true> as Resolvable>::To

The output that the future will produce on completion.

type IntoFuture = Ready<<AdvancedSubscriberBuilder<'_, '_, '_, Callback<Sample>, true> 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<Handler> IntoFuture for AdvancedSubscriberBuilder<'_, '_, '_, Handler>

where Handler: IntoHandler<Sample> + Send, Handler::Handler: Send,

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

The output that the future will produce on completion.

type IntoFuture = Ready<<AdvancedSubscriberBuilder<'_, '_, '_, Handler> 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 Resolvable for AdvancedSubscriberBuilder<'_, '_, '_, Callback<Sample>, true>

type To = Result<(), Box<dyn Error + Send + Sync>>

impl<Handler> Resolvable for AdvancedSubscriberBuilder<'_, '_, '_, Handler>

where Handler: IntoHandler<Sample>, Handler::Handler: Send,

type To = Result<AdvancedSubscriber<<Handler as IntoHandler<Sample>>::Handler>, Box<dyn Error + Send + Sync>>

impl Wait for AdvancedSubscriberBuilder<'_, '_, '_, Callback<Sample>, true>

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

Synchronously execute and wait

impl<Handler> Wait for AdvancedSubscriberBuilder<'_, '_, '_, Handler>

where Handler: IntoHandler<Sample> + Send, Handler::Handler: Send,

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

Synchronously execute and wait