Skip to main content

NotificationOutcome

Struct NotificationOutcome 

Source
pub struct NotificationOutcome { /* private fields */ }
Available on crate feature agent only.
Expand description

Aggregate outcome of sending a notification to all configured sinks.

Returned by Agent::send_trap and Agent::send_inform so callers can observe success, failure, or an explicit skip for every configured sink.

Implementations§

Source§

impl NotificationOutcome

Source

pub fn sinks(&self) -> &[SinkOutcome]

Per-sink outcomes, in sink configuration order.

Source

pub fn failures(&self) -> impl Iterator<Item = &SinkOutcome>

Iterator over the sinks whose delivery failed.

Source

pub fn skipped(&self) -> impl Iterator<Item = &SinkOutcome>

Iterator over configured sinks that were not attempted.

Source

pub fn all_succeeded(&self) -> bool

true if every configured sink succeeded.

This is also true when no sinks are configured, but is false when any configured sink failed or was skipped.

Source

pub fn len(&self) -> usize

Number of configured sinks represented in this outcome.

Source

pub fn is_empty(&self) -> bool

true if no sinks were configured.

Source

pub fn into_sinks(self) -> Vec<SinkOutcome>

Consume the outcome, returning the per-sink outcomes.

Trait Implementations§

Source§

impl Debug for NotificationOutcome

Source§

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

Formats the value using the given formatter. 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> 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<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