Struct NotifyOutcome 

#[non_exhaustive]
pub struct NotifyOutcome {
    pub sent: bool,
    pub listeners_notified: usize,
}

Outcome of a Publisher send operation.

Returned by Publisher::send_copy, Publisher::loan_send, and Publisher::loan. Inspect listeners_notified to detect dropped notifications: a value smaller than the number of subscribers known to be attached indicates that at least one listener’s kernel socket buffer was full when the publisher tried to wake it. iceoryx2 will also log a FailedToDeliverSignal warning per dropped delivery; this struct lets callers detect the same condition programmatically without parsing logs.

Note that listeners_notified == 0 is not always a problem — it just means no listeners were attached at the moment of notification (e.g. no subscribers exist yet, which is normal during startup).

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

sent: bool

true if the message was published. For loan_send and loan, this reflects the closure’s return value: false means the closure asked to skip the send (no payload was sent and no notification fired).

listeners_notified: usize

Number of listeners the notification was successfully delivered to. Always 0 when sent == false. May be less than the expected listener count under back-pressure — see the type-level docs.

Implementations

impl NotifyOutcome

pub const fn delivered_to_any_listener(self) -> bool

Convenience: true iff the message was sent AND at least one listener was woken. Useful for asserting end-to-end pickup in tests.

Trait Implementations

impl Clone for NotifyOutcome

fn clone(&self) -> NotifyOutcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NotifyOutcome

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

Formats the value using the given formatter.

impl Hash for NotifyOutcome

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for NotifyOutcome

fn eq(&self, other: &NotifyOutcome) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for NotifyOutcome

impl Eq for NotifyOutcome

impl StructuralPartialEq for NotifyOutcome