subspace_farmer::cluster::nats_client

Struct NatsClient

source
pub struct NatsClient { /* private fields */ }
Expand description

NATS client wrapper that can be used to interact with other Subspace-specific clients

Implementations§

source§

impl NatsClient

source

pub async fn new<A: ToServerAddrs>( addrs: A, request_retry_backoff_policy: ExponentialBackoff, ) -> Result<Self, Error>

Create new instance by connecting to specified addresses

source

pub fn from_client( client: Client, request_retry_backoff_policy: ExponentialBackoff, ) -> Result<Self, Error>

Create new client from existing NATS instance

source

pub fn approximate_max_message_size(&self) -> usize

Approximate max message size (a few more bytes will not hurt), the actual limit is expected to be a bit higher

source

pub async fn request<Request>( &self, request: &Request, instance: Option<&str>, ) -> Result<Request::Response, RequestError>
where Request: GenericRequest,

Make request and wait for response

source

pub async fn request_responder<Request, F, OP>( &self, instance: Option<&str>, queue_group: Option<String>, process: OP, ) -> Result<()>
where Request: GenericRequest, F: Future<Output = Option<Request::Response>> + Send, OP: Fn(Request) -> F + Send + Sync,

Responds to requests from the given subject using the provided processing function.

This will create a subscription on the subject for the given instance (if provided) and queue group. Incoming messages will be deserialized as the request type Request and passed to the process function to produce a response of type Request::Response. The response will then be sent back on the reply subject from the original request.

Each request is processed in a newly created async tokio task.

§Arguments
  • instance - Optional instance name to use in place of the * in the subject
  • group - The queue group name for the subscription
  • process - The function to call with the decoded request to produce a response
source

pub async fn stream_request<Request>( &self, request: &Request, instance: Option<&str>, ) -> Result<StreamResponseSubscriber<Request::Response>, StreamRequestError>
where Request: GenericStreamRequest,

Make request that expects stream response

source

pub async fn stream_request_responder<Request, F, S, OP>( &self, instance: Option<&str>, queue_group: Option<String>, process: OP, ) -> Result<()>
where Request: GenericStreamRequest, F: Future<Output = Option<S>> + Send, S: Stream<Item = Request::Response> + Unpin, OP: Fn(Request) -> F + Send + Sync,

Responds to stream requests from the given subject using the provided processing function.

This will create a subscription on the subject for the given instance (if provided) and queue group. Incoming messages will be deserialized as the request type Request and passed to the process function to produce a stream response of type Request::Response. The stream response will then be sent back on the reply subject from the original request.

Each request is processed in a newly created async tokio task.

§Arguments
  • instance - Optional instance name to use in place of the * in the subject
  • group - The queue group name for the subscription
  • process - The function to call with the decoded request to produce a response
source

pub async fn notification<Notification>( &self, notification: &Notification, instance: Option<&str>, ) -> Result<(), PublishError>
where Notification: GenericNotification,

Make notification without waiting for response

source

pub async fn broadcast<Broadcast>( &self, message: &Broadcast, instance: &str, ) -> Result<(), PublishError>
where Broadcast: GenericBroadcast,

Send a broadcast message

source

pub async fn subscribe_to_notifications<Notification>( &self, instance: Option<&str>, queue_group: Option<String>, ) -> Result<SubscriberWrapper<Notification>, SubscribeError>
where Notification: GenericNotification,

Simple subscription that will produce decoded notifications, while skipping messages that fail to decode

source

pub async fn subscribe_to_broadcasts<Broadcast>( &self, instance: Option<&str>, queue_group: Option<String>, ) -> Result<SubscriberWrapper<Broadcast>, SubscribeError>
where Broadcast: GenericBroadcast,

Simple subscription that will produce decoded broadcasts, while skipping messages that fail to decode

Methods from Deref<Target = Client>§

pub fn server_info(&self) -> ServerInfo

Returns last received info from the server.

§Examples
let client = async_nats::connect("demo.nats.io").await?;
println!("info: {:?}", client.server_info());

pub fn is_server_compatible(&self, major: i64, minor: i64, patch: i64) -> bool

Returns true if the server version is compatible with the version components.

This has to be used with caution, as it is not guaranteed that the server that client is connected to is the same version that the one that is a JetStream meta/stream/consumer leader, especially across leafnodes.

§Examples
let client = async_nats::connect("demo.nats.io").await?;
assert!(client.is_server_compatible(2, 8, 4));

pub async fn publish<S>( &self, subject: S, payload: Bytes, ) -> Result<(), Error<PublishErrorKind>>
where S: ToSubject,

Publish a [Message] to a given subject.

§Examples
let client = async_nats::connect("demo.nats.io").await?;
client.publish("events.data", "payload".into()).await?;

pub async fn publish_with_headers<S>( &self, subject: S, headers: HeaderMap, payload: Bytes, ) -> Result<(), Error<PublishErrorKind>>
where S: ToSubject,

Publish a [Message] with headers to a given subject.

§Examples
use std::str::FromStr;
let client = async_nats::connect("demo.nats.io").await?;
let mut headers = async_nats::HeaderMap::new();
headers.insert(
    "X-Header",
    async_nats::HeaderValue::from_str("Value").unwrap(),
);
client
    .publish_with_headers("events.data", headers, "payload".into())
    .await?;

pub async fn publish_with_reply<S, R>( &self, subject: S, reply: R, payload: Bytes, ) -> Result<(), Error<PublishErrorKind>>
where S: ToSubject, R: ToSubject,

Publish a [Message] to a given subject, with specified response subject to which the subscriber can respond. This method does not await for the response.

§Examples
let client = async_nats::connect("demo.nats.io").await?;
client
    .publish_with_reply("events.data", "reply_subject", "payload".into())
    .await?;

pub async fn publish_with_reply_and_headers<S, R>( &self, subject: S, reply: R, headers: HeaderMap, payload: Bytes, ) -> Result<(), Error<PublishErrorKind>>
where S: ToSubject, R: ToSubject,

Publish a [Message] to a given subject with headers and specified response subject to which the subscriber can respond. This method does not await for the response.

§Examples
use std::str::FromStr;
let client = async_nats::connect("demo.nats.io").await?;
let mut headers = async_nats::HeaderMap::new();
client
    .publish_with_reply_and_headers("events.data", "reply_subject", headers, "payload".into())
    .await?;

pub async fn request<S>( &self, subject: S, payload: Bytes, ) -> Result<Message, Error<RequestErrorKind>>
where S: ToSubject,

Sends the request with headers.

§Examples
let client = async_nats::connect("demo.nats.io").await?;
let response = client.request("service", "data".into()).await?;

pub async fn request_with_headers<S>( &self, subject: S, headers: HeaderMap, payload: Bytes, ) -> Result<Message, Error<RequestErrorKind>>
where S: ToSubject,

Sends the request with headers.

§Examples
let client = async_nats::connect("demo.nats.io").await?;
let mut headers = async_nats::HeaderMap::new();
headers.insert("Key", "Value");
let response = client
    .request_with_headers("service", headers, "data".into())
    .await?;

pub async fn send_request<S>( &self, subject: S, request: Request, ) -> Result<Message, Error<RequestErrorKind>>
where S: ToSubject,

Sends the request created by the [Request].

§Examples
let client = async_nats::connect("demo.nats.io").await?;
let request = async_nats::Request::new().payload("data".into());
let response = client.send_request("service", request).await?;

pub fn new_inbox(&self) -> String

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

§Examples
let reply = nc.new_inbox();
let rsub = nc.subscribe(reply).await?;

pub async fn subscribe<S>( &self, subject: S, ) -> Result<Subscriber, SubscribeError>
where S: ToSubject,

Subscribes to a subject to receive [messages][Message].

§Examples
use futures::StreamExt;
let client = async_nats::connect("demo.nats.io").await?;
let mut subscription = client.subscribe("events.>").await?;
while let Some(message) = subscription.next().await {
    println!("received message: {:?}", message);
}

pub async fn queue_subscribe<S>( &self, subject: S, queue_group: String, ) -> Result<Subscriber, SubscribeError>
where S: ToSubject,

Subscribes to a subject with a queue group to receive [messages][Message].

§Examples
use futures::StreamExt;
let client = async_nats::connect("demo.nats.io").await?;
let mut subscription = client.queue_subscribe("events.>", "queue".into()).await?;
while let Some(message) = subscription.next().await {
    println!("received message: {:?}", message);
}

pub async fn flush(&self) -> Result<(), Error<FlushErrorKind>>

Flushes the internal buffer ensuring that all messages are sent.

§Examples
let client = async_nats::connect("demo.nats.io").await?;
client.flush().await?;

pub fn connection_state(&self) -> State

Returns the current state of the connection.

§Examples
let client = async_nats::connect("demo.nats.io").await?;
println!("connection state: {}", client.connection_state());

pub async fn force_reconnect(&self) -> Result<(), ReconnectError>

Forces the client to reconnect. Keep in mind that client will reconnect automatically if the connection is lost and this method does not have to be used in normal circumstances. However, if you want to force the client to reconnect, for example to re-trigger the auth-callback, or manually rebalance connections, this method can be useful. This method does not wait for connection to be re-established.

§Examples
let client = async_nats::connect("demo.nats.io").await?;
client.force_reconnect().await?;

pub fn statistics(&self) -> Arc<Statistics>

Returns struct representing statistics of the whole lifecycle of the client. This includes number of bytes sent/received, number of messages sent/received, and number of times the connection was established. As this returns Arc with [AtomicU64] fields, it can be safely reused and shared across threads.

§Examples
let client = async_nats::connect("demo.nats.io").await?;
let statistics = client.statistics();
println!("client statistics: {:#?}", statistics);

Trait Implementations§

source§

impl Clone for NatsClient

source§

fn clone(&self) -> NatsClient

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for NatsClient

source§

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

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

impl Deref for NatsClient

source§

type Target = Client

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.

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<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pipe for T
where T: ?Sized,

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

source§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
§

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> JsonSchemaMaybe for T

§

impl<T> MaybeSend for T
where T: Send,