Skip to main content

NatsSubscriber

Struct NatsSubscriber 

Source
pub struct NatsSubscriber { /* private fields */ }
Expand description

A NATS subscription.

Backed transparently by either a Core subscription (no ack) or a JetStream pull consumer (full ack/nack/term). Construct via crate::NatsBroker::subscribe with crate::SubscribeOptions.

Trait Implementations§

Source§

impl BatchSubscriber for NatsSubscriber

Source§

fn batches( &mut self, ) -> impl Stream<Item = Result<Self::Batch, Self::Error>> + Send + '_

Returns a stream of message batches.

JetStream batches natively: one stream item is one fetch of up to pull_batch messages, waiting at most pull_expires before delivering a partial batch (an empty fetch is retried, so the stream never yields empty batches). Core NATS has no wire-level batching; there a batch is whatever the client has already buffered locally (at least one message, at most [CORE_BATCH_LIMIT]), with no added latency.

Drive a subscriber through either Subscriber::stream or batches, not both at once: on JetStream each issues its own pull requests, so deliveries would be split between them.

§Cancel safety

Dropping the returned stream between items is allowed. On JetStream, dropping it mid-fetch can leave already-fetched, undelivered messages to be redelivered after the consumer’s ack_wait.

Source§

type Batch = Vec<NatsMessage>

Container yielded by batches. Implementations choose between Vec, custom iterators, or anything else that yields the underlying Subscriber::Message.
Source§

impl Debug for NatsSubscriber

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Subscriber for NatsSubscriber

Source§

type Message = NatsMessage

The message type yielded by this subscriber.
Source§

type Error = NatsError

The error type yielded by the stream when delivery fails.
Source§

fn stream( &mut self, ) -> impl Stream<Item = Result<Self::Message, Self::Error>> + Send + '_

Returns a stream of broker deliveries. Read more

Auto Trait Implementations§

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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

Source§

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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more