Struct nats::Subscription

pub struct Subscription(_);

A Subscription receives Messages published to specific NATS Subjects.

Implementations

impl Subscription

pub fn receiver(&self) -> &Receiver<Message>

Get a crossbeam Receiver for subscription messages. Useful for crossbeam_channel::select macro

Example

let sub1_ch = sub1.receiver();
let sub2_ch = sub2.receiver();
crossbeam_channel::select! {
    recv(sub1_ch) -> msg => {
        println!("Got message from sub1: {:?}", msg);
        Ok(())
    }
    recv(sub2_ch) -> msg => {
        println!("Got message from sub2: {:?}", msg);
        Ok(())
    }
}

pub fn next(&self) -> Option<Message>

Get the next message, or None if the subscription has been unsubscribed or the connection closed.

Example

if let Some(msg) = sub.next() {}

pub fn try_next(&self) -> Option<Message>

Try to get the next message, or None if no messages are present or if the subscription has been unsubscribed or the connection closed.

Example

if let Some(msg) = sub.try_next() {
  println!("Received {}", msg);
}

pub fn next_timeout(&self, timeout: Duration) -> Result<Message>

Get the next message, or a timeout error if no messages are available for timout.

Example

if let Ok(msg) = sub.next_timeout(std::time::Duration::from_secs(1)) {}

pub fn messages(&self) -> Iter<'_>

Returns a blocking message iterator. Same as calling iter().

Example

for msg in sub.messages() {}

pub fn iter(&self) -> Iter<'_>

Returns a blocking message iterator.

Example

for msg in sub.iter() {}

pub fn try_iter(&self) -> TryIter<'_>

Returns a non-blocking message iterator.

Example

for msg in sub.try_iter() {}

pub fn timeout_iter(&self, timeout: Duration) -> TimeoutIter<'_>

Returns a blocking message iterator with a time deadline for blocking.

Example

for msg in sub.timeout_iter(std::time::Duration::from_secs(1)) {}

pub fn with_handler<F>(self, handler: F) -> Handler where
    F: Fn(Message) -> Result<()> + Send + 'static, 

Attach a closure to handle messages. This closure will execute in a separate thread. The result of this call is a Handler which can not be iterated and must be unsubscribed or closed directly to unregister interest. A Handler will not unregister interest with the server when drop(&mut self) is called.

Example

nc.subscribe("bar")?.with_handler(move |msg| {
    println!("Received {}", &msg);
    Ok(())
});

pub fn set_message_limits(&self, limit: usize)

Sets limit of how many messages can wait in internal queue. If limit will be reached, error_callback will be fired with information which subscription is affected

Example

let sub =  nc.subscribe("bar")?;
sub.set_message_limits(1000);

pub fn dropped_messages(&self) -> Result<usize>

Returns number of dropped messages for this Subscription. Dropped messages occur when set_message_limits is set and threashold is reached, triggering slow consumer error.

Example:

let sub =  nc.subscribe("bar")?;
sub.set_message_limits(1000);
println!("dropped messages: {}", sub.dropped_messages()?);

pub fn unsubscribe(self) -> Result<()>

Unsubscribe a subscription immediately without draining. Use drain instead if you want any pending messages to be processed by a handler, if one is configured.

Example

let sub = nc.subscribe("foo")?;
sub.unsubscribe()?;

pub fn close(self) -> Result<()>

Close a subscription. Same as unsubscribe

Use drain instead if you want any pending messages to be processed by a handler, if one is configured.

Example

let sub = nc.subscribe("foo")?;
sub.close()?;

pub fn drain(&self) -> Result<()>

Send an unsubscription then flush the connection, allowing any unprocessed messages to be handled by a handler function if one is configured.

After the flush returns, we know that a round-trip to the server has happened after it received our unsubscription, so we shut down the subscriber afterwards.

A similar method exists on the Connection struct which will drain all subscriptions for the NATS client, and transition the entire system into the closed state afterward.

Example

let mut sub = nc.subscribe("test.drain")?;

nc.publish("test.drain", "message")?;
sub.drain()?;

let mut received = false;
for _ in sub {
    received = true;
}

assert!(received);

Trait Implementations

impl Clone for Subscription

fn clone(&self) -> Subscription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Subscription

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

Formats the value using the given formatter.

impl IntoIterator for Subscription

type Item = Message

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a Subscription

type Item = Message

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a>

Creates an iterator from a value.