Skip to main content

SendOptions

Struct SendOptions 

Source
pub struct SendOptions {
    pub lane: MessageLane,
    pub priority: Priority,
    pub enqueue_timeout: Option<Duration>,
    pub write_timeout: Duration,
    pub deadline: Option<Instant>,
    pub retry: SendRetryPolicy,
    pub disconnected: DisconnectedPolicy,
    pub cancellation: Option<CancellationGroup>,
    pub metadata: Metadata,
}
Expand description

Scheduling, cancellation, retry, and per-stage deadline configuration for one outbound message.

Fields§

§lane: MessageLane

The normal or emergency sending channel used by the message. The default is the normal channel.

§priority: Priority

The scheduling priority within the normal channel; the emergency channel only accepts Normal.

§enqueue_timeout: Option<Duration>

Maximum time from the builder’s first admission attempt until queue resources are acquired; None imposes no separate admission limit. Repeated admission attempts for the same builder use the original start point, while the overall deadline remains in force.

§write_timeout: Duration

The overall time limit for each actual write attempt, covering all shards of the message, defaults to 10 seconds.

§deadline: Option<Instant>

The original absolute deadline covering all stages, including queuing and reconnection waiting; None means there is no overall deadline.

§retry: SendRetryPolicy

Retry permission after delivery failure; no retry by default. When retrying is allowed, the application must ensure the safety of repeated delivery.

§disconnected: DisconnectedPolicy

How to handle cases where the connection is not connected during admission or the connection is interrupted during waiting. The default is to reject the request.

§cancellation: Option<CancellationGroup>

A cancellation group that can uniformly cancel a group of operations; None means not to join the cancellation group.

§metadata: Metadata

Local application metadata attached to the send operation; it is not automatically added to the wire message payload.

Implementations§

Source§

impl SendOptions

Source

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

Checks configuration without starting timers or changing the deadline.

A zero timeout or an elapsed absolute deadline represents an immediate operational timeout, rather than an invalid configuration.

Trait Implementations§

Source§

impl Clone for SendOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SendOptions

Source§

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

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

impl Default for SendOptions

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> 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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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