[−][src]Struct nats::subscription::Subscription
A Subscription
receives Message
s published to specific NATS Subject
s.
Implementations
impl Subscription
[src]
pub fn next(&self) -> Option<Message>
[src]
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>
[src]
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, RecvTimeoutError>
[src]
&self,
timeout: Duration
) -> Result<Message, RecvTimeoutError>
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 const fn messages(&self) -> Iter
[src]
pub const fn iter(&self) -> Iter
[src]
pub const fn try_iter(&self) -> TryIter
[src]
pub const fn timeout_iter(&self, timeout: Duration) -> TimeoutIter
[src]
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<()> + Sync + Send + 'static,
[src]
F: Fn(Message) -> Result<()> + Sync + 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 unsubscribe(self) -> Result<()>
[src]
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<()>
[src]
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(&mut self) -> Result<()>
[src]
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
[src]
fn clone(&self) -> Subscription
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for Subscription
[src]
impl IntoIterator for Subscription
[src]
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
[src]
impl<'a> IntoIterator for &'a Subscription
[src]
Auto Trait Implementations
impl !RefUnwindSafe for Subscription
impl Send for Subscription
impl Sync for Subscription
impl Unpin for Subscription
impl !UnwindSafe for Subscription
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<I> IntoIterator for I where
I: Iterator,
[src]
I: Iterator,
type Item = <I as Iterator>::Item
The type of the elements being iterated over.
type IntoIter = I
Which kind of iterator are we turning this into?
fn into_iter(self) -> I
[src]
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,