Skip to main content

AckSubOptions

object_transfer::nats::options

Struct AckSubOptions 

Source 
pub struct AckSubOptions { /* private fields */ }
Expand description

Configuration options for creating an acknowledgment-based subscriber.

This struct provides a builder pattern for configuring NATS JetStream consumers with pull-based message consumption and automatic acknowledgment options.

Implementations§

Source§

impl AckSubOptions

Source

pub fn new(format: Format, name: Arc<str>) -> Self

Creates a new AckSubOptions with the specified format and name.

§Arguments
  • format - The message format to use for serialization/deserialization
  • name - The name for both the stream and consumer
§Returns

A new AckSubOptions instance with default settings and auto-acknowledgment enabled

Source

pub fn auto_ack(self, auto_ack: bool) -> Self

Sets whether messages should be automatically acknowledged.

§Arguments
  • auto_ack - If true, messages will be automatically acknowledged after processing
§Returns

Self for method chaining

Source

pub fn name(self, name: impl Into<String>) -> Self

Sets the stream name.

§Arguments
  • name - The name to assign to the stream
§Returns

Self for method chaining

Source

pub fn subjects(self, subjects: Vec<impl Into<String>>) -> Self

Sets the subjects that the stream should listen to.

§Arguments
  • subjects - A vector of subject patterns to subscribe to
§Returns

Self for method chaining

Source

pub fn durable_name(self, durable_name: impl Into<String>) -> Self

Sets the durable name for the consumer.

A durable consumer will persist its state and can resume consumption after disconnection.

§Arguments
  • durable_name - The durable name for the consumer
§Returns

Self for method chaining

Source

pub fn format(self, format: Format) -> Self

Sets the message format for serialization/deserialization.

§Arguments
  • format - The format to use for message encoding
§Returns

Self for method chaining

Source

pub fn stream_config(self, stream_cfg: StreamConfig) -> Self

Sets the complete stream configuration.

This replaces the entire stream configuration with the provided one.

§Arguments
  • stream_cfg - The stream configuration to use
§Returns

Self for method chaining

Source

pub fn pull_config(self, pull_cfg: PullConfig) -> Self

Sets the complete pull consumer configuration.

This replaces the entire pull consumer configuration with the provided one.

§Arguments
  • pull_cfg - The pull consumer configuration to use
§Returns

Self for method chaining

Trait Implementations§

Source§

impl Debug for AckSubOptions

Source§

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

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

impl SubOptTrait for AckSubOptions

Source§

fn get_auto_ack(&self) -> bool

Source§

fn get_format(&self) -> Format

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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

Source§

type Output = T

Should always be Self
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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