Enum ReceiveResult 

pub enum ReceiveResult<T> {
    Message(Box<ReceivedMessage<T>>),
    Shutdown,
    ConnectionLost {
        reason: String,
    },
    Timeout,
    ChannelClosed,
    ConsumerCancelled,
    Retryable {
        reason: String,
        retry_after: Option<Duration>,
    },
}

Result of a receive operation from a message backend.

This enum provides explicit semantics for different receive outcomes, allowing callers to distinguish between graceful shutdown, connection loss, transient errors, and successful message receipt.

Examples

use foxtive_worker::backends::ReceiveResult;

async fn process_messages(backend: &dyn foxtive_worker::backends::MessageBackend) -> anyhow::Result<()> {
    loop {
        match backend.receive().await? {
            ReceiveResult::Message(msg) => {
                // Process the message
                println!("Received: {}", msg.message.id);
            }
            ReceiveResult::Shutdown => {
                // Backend is shutting down gracefully
                break;
            }
            ReceiveResult::ConnectionLost { reason } => {
                // Connection lost - trigger reconnection
                eprintln!("Connection lost: {}", reason);
                return Err(anyhow::anyhow!("Connection lost: {}", reason));
            }
            _ => {
                // Handle other cases
            }
        }
    }
    Ok(())
}

Variants

Message(Box<ReceivedMessage<T>>)

Message received successfully

Shutdown

Backend is shutting down gracefully (shutdown() was called)

ConnectionLost

Connection lost - requires reconnection

Fields

reason: String

Reason for connection loss

Timeout

Operation timed out

ChannelClosed

Consumer channel was closed unexpectedly

ConsumerCancelled

Consumer was cancelled by broker or client

Retryable

Transient error that may resolve on retry

Fields

reason: String

Error description

retry_after: Option<Duration>

Optional suggested wait time before retrying

Implementations

impl<T> ReceiveResult<T>

pub fn is_message(&self) -> bool

Check if a message was received

pub fn is_shutdown(&self) -> bool

Check if the backend is shutting down

pub fn needs_reconnection(&self) -> bool

Check if reconnection is needed

pub fn is_retryable(&self) -> bool

Check if the operation should be retried

pub fn into_message(self) -> Option<ReceivedMessage<T>>

Extract the message if present

pub fn status_str(&self) -> &'static str

Get a description of the result status

Trait Implementations

impl<T: Debug> Debug for ReceiveResult<T>

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

Formats the value using the given formatter.

impl<T> Display for ReceiveResult<T>

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

Formats the value using the given formatter.

impl<T> Error for ReceiveResult<T>

where Self: Debug + Display,

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.