Struct nats::Connection

pub struct Connection { /* fields omitted */ }

A NATS connection.

Methods

impl Connection

pub fn subscribe(&self, subject: &str) -> Result<Subscription>

Create a subscription for the given NATS connection.

Example

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

pub fn queue_subscribe(
    &self,
    subject: &str,
    queue: &str
) -> Result<Subscription>

Create a queue subscription for the given NATS connection.

Example

let sub = nc.queue_subscribe("foo", "production")?;

pub fn publish(&self, subject: &str, msg: impl AsRef<[u8]>) -> Result<()>

Publish a message on the given subject.

Example

nc.publish("foo", "Hello World!")?;

pub fn publish_request(
    &self,
    subject: &str,
    reply: &str,
    msg: impl AsRef<[u8]>
) -> Result<()>

Publish a message on the given subject with a reply subject for responses.

Example

let reply = nc.new_inbox();
let rsub = nc.subscribe(&reply)?;
nc.publish_request("foo", &reply, "Help me!")?;

pub fn new_inbox(&self) -> String

Create a new globally unique inbox which can be used for replies.

Example

let reply = nc.new_inbox();
let rsub = nc.subscribe(&reply)?;

pub fn request(&self, subject: &str, msg: impl AsRef<[u8]>) -> Result<Message>

Publish a message on the given subject as a request and receive the response.

Example

let resp = nc.request("foo", "Help me?")?;

pub fn request_timeout(
    &self,
    subject: &str,
    msg: impl AsRef<[u8]>,
    timeout: Duration
) -> Result<Message>

Publish a message on the given subject as a request and receive the response. This call will return after the timeout duration if no response is received.

Example

let resp = nc.request_timeout("foo", "Help me?", std::time::Duration::from_secs(2))?;

pub fn request_multi(
    &self,
    subject: &str,
    msg: impl AsRef<[u8]>
) -> Result<Subscription>

Publish a message on the given subject as a request and allow multiple responses.

Example

for msg in nc.request_multi("foo", "Help")?.iter().take(1) {}

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

Flush a NATS connection by sending a PING protocol and waiting for the responding PONG.

Example

nc.flush()?;

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

Close a NATS connection.

Example

nc.close()?;

Trait Implementations

impl Clone for Connection

fn clone(&self) -> Connection

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Connection

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

Formats the value using the given formatter.