Struct nats::subscription::Subscription [−][src]
pub struct Subscription(_);
Expand description
A Subscription
receives Message
s published
to specific NATS Subject
s.
Implementations
impl Subscription
[src]
impl Subscription
[src]pub fn receiver(&self) -> &Receiver<Message>
[src]
pub fn receiver(&self) -> &Receiver<Message>
[src]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>
[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]
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>
[src]
pub fn next_timeout(&self, timeout: Duration) -> Result<Message>
[src]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 timeout_iter(&self, timeout: Duration) -> TimeoutIter<'_>ⓘNotable traits for TimeoutIter<'a>
impl<'a> Iterator for TimeoutIter<'a> type Item = Message;
[src]
pub fn timeout_iter(&self, timeout: Duration) -> TimeoutIter<'_>ⓘNotable traits for TimeoutIter<'a>
impl<'a> Iterator for TimeoutIter<'a> type Item = Message;
[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<()> + Send + 'static,
[src]
pub fn with_handler<F>(self, handler: F) -> Handler where
F: Fn(Message) -> Result<()> + Send + 'static,
[src]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]
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]
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(&self) -> Result<()>
[src]
pub fn drain(&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]
impl Clone for Subscription
[src]fn clone(&self) -> Subscription
[src]
fn clone(&self) -> Subscription
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for Subscription
[src]
impl Debug for Subscription
[src]impl IntoIterator for Subscription
[src]
impl IntoIterator for Subscription
[src]impl<'a> IntoIterator for &'a Subscription
[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> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> Same<T> for T
impl<T> Same<T> for T
type Output = T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,