Skip to main content

ReceiveOptions

Struct ReceiveOptions 

Source
pub struct ReceiveOptions {
    pub max_messages: u32,
    pub timeout: Duration,
    pub session_id: Option<SessionId>,
    pub accept_any_session: bool,
    pub lock_duration: Option<Duration>,
    pub peek_only: bool,
    pub from_sequence_number: Option<u64>,
}
Expand description

Configuration options for receiving messages from queues

Fields§

§max_messages: u32

Maximum number of messages to receive in a batch

§timeout: Duration

Timeout duration for receive operations

§session_id: Option<SessionId>

Session ID for session-specific message consumption

§accept_any_session: bool

Whether to accept any available session

§lock_duration: Option<Duration>

Message lock duration for processing time management

§peek_only: bool

Peek-only mode for message inspection without consumption

§from_sequence_number: Option<u64>

Sequence number for replay and recovery scenarios

Implementations§

Source§

impl ReceiveOptions

Source

pub fn new() -> Self

Create new receive options with defaults

Source

pub fn with_max_messages(self, max: u32) -> Self

Set maximum number of messages to receive

Source

pub fn with_timeout(self, timeout: Duration) -> Self

Set timeout duration

Source

pub fn with_session_id(self, session_id: SessionId) -> Self

Set specific session ID to consume from

Source

pub fn accept_any_session(self) -> Self

Accept messages from any available session

Source

pub fn with_lock_duration(self, duration: Duration) -> Self

Set message lock duration

Source

pub fn peek_only(self) -> Self

Enable peek-only mode (inspect without consuming)

Source

pub fn from_sequence_number(self, sequence: u64) -> Self

Set starting sequence number for replay

Trait Implementations§

Source§

impl Clone for ReceiveOptions

Source§

fn clone(&self) -> ReceiveOptions

Returns a duplicate 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 ReceiveOptions

Source§

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

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

impl Default for ReceiveOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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, dest: *mut u8)

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

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

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