Struct ContextBuilder 

pub struct ContextBuilder<PREFIX: ToAssign> { /* private fields */ }

A builder for Context. Beyond what can be set by standard constructor, it allows tweaking pending publish ack backpressure settings.

Examples

let client = async_nats::connect("demo.nats.io").await?;
let context = ContextBuilder::new()
    .timeout(Duration::from_secs(5))
    .api_prefix("MY.JS.API")
    .max_ack_inflight(1000)
    .build(client);

Implementations

impl ContextBuilder<Yes>

pub fn new() -> ContextBuilder<Yes>

Create a new ContextBuilder with default settings.

impl ContextBuilder<Yes>

pub fn api_prefix<T: Into<String>>(self, prefix: T) -> ContextBuilder<No>

Set the prefix for the JetStream API.

pub fn domain<T: Into<String>>(self, domain: T) -> ContextBuilder<No>

Set the domain for the JetStream API. Domain is the middle part of standard API prefix: $JS.{domain}.API.

impl<PREFIX> ContextBuilder<PREFIX>

where PREFIX: ToAssign,

pub fn timeout(self, timeout: Duration) -> ContextBuilder<Yes>

where Yes: ToAssign,

Set the timeout for all JetStream API requests.

pub fn ack_timeout(self, ack_timeout: Duration) -> ContextBuilder<Yes>

where Yes: ToAssign,

Sets the maximum time client waits for acks from the server when default backpressure is used.

pub fn max_ack_inflight(self, capacity: usize) -> ContextBuilder<Yes>

where Yes: ToAssign,

Sets the maximum number of pending acks that can be in flight at any given time. If limit is reached, publish throws an error by default, or waits if backpressure is enabled.

pub fn backpressure_on_inflight(self, enabled: bool) -> ContextBuilder<Yes>

where Yes: ToAssign,

Enable or disable backpressure when max inflight acks is reached. When enabled, publish will wait for permits to become available instead of returning an error. Default is false (errors on max inflight).

pub fn concurrency_limit(self, limit: Option<usize>) -> ContextBuilder<Yes>

where Yes: ToAssign,

Sets the concurrency limit for the ack handler task. This might be useful in scenarios where Tokio runtime is under heavy load.

pub fn build(self, client: Client) -> Context

Build the Context with the given settings.

Trait Implementations

impl Default for ContextBuilder<Yes>

fn default() -> Self

Returns the “default value” for a type.