DeadLetterQueue

Struct DeadLetterQueue 

Source
pub struct DeadLetterQueue {
    pub config: SdkConfig,
    pub client: Client,
}
Expand description

Client for interacting with AWS SQS dead letter queues.

Provides high-level operations for listing queues, polling messages, and clearing messages from queues.

§Example

use dlq::DeadLetterQueue;

let config = aws_config::from_env().load().await;
let dlq = DeadLetterQueue::from_config(config);

// List all queues
let queues = dlq.list().await;

// Poll messages from a queue
dlq.poll("https://sqs.us-east-1.amazonaws.com/123456789/my-dlq").await;

Fields§

§config: SdkConfig

The AWS SDK configuration used for SQS operations

§client: Client

The SQS client instance

Implementations§

Source§

impl DeadLetterQueue

Source

pub async fn send_batch( &self, queue_url: &str, messages: &[impl AsRef<str>], ) -> Result<(), SendError>

Sends multiple messages to SQS in a single batch request.

Uses the SQS SendMessageBatch API to efficiently send up to 10 messages at once. Each message is assigned a unique UUID as its batch entry ID.

§Arguments
  • queue_url - The URL of the SQS queue to send messages to
  • messages - A slice of message bodies to send. Each item must implement AsRef<str>.
§Returns
  • Ok(()) - All messages were sent successfully
  • Err(SendError) - An error occurred during the send operation
§Errors
  • SendError::BuildEntryFailed - A message entry couldn’t be constructed
  • SendError::AwsSdkError - The SQS API returned an error
§Example
use dlq::DeadLetterQueue;

let config = aws_config::from_env().load().await;
let dlq = DeadLetterQueue::from_config(config);

// Send multiple messages
dlq.send_batch("https://sqs.us-east-1.amazonaws.com/123/my-queue", &["message 1", "message 2", "message 3"]).await?;

// Empty batch is handled gracefully
let empty: Vec<String> = vec![];
dlq.send_batch("https://sqs.us-east-1.amazonaws.com/123/my-queue", &empty).await?;
Source§

impl DeadLetterQueue

Source

pub fn from_config(config: SdkConfig) -> Self

Creates a DeadLetterQueue from a pre-built AWS SDK config.

This is the preferred constructor as it allows the caller to configure credentials and endpoints based on their needs (e.g., --local flag for LocalStack).

§Arguments
  • config - Pre-configured AWS SDK configuration
§Example
use dlq::DeadLetterQueue;

let config = aws_config::from_env().load().await;
let dlq = DeadLetterQueue::from_config(config);

// List all queues
let queues = dlq.list().await;
Source

pub async fn _clear( &self, url: String, message_id: String, receipt_handle: String, )

Deletes a message from the queue using batch delete.

This is primarily used internally to acknowledge processed messages.

§Arguments
  • url - The queue URL
  • message_id - The SQS message ID
  • receipt_handle - The receipt handle from when the message was received
Source

pub async fn list(&self) -> Vec<String>

Lists all SQS queue URLs in the AWS account.

Handles pagination automatically, returning all queues regardless of count.

§Returns

A vector of queue URL strings.

§Example
use dlq::DeadLetterQueue;

let config = aws_config::from_env().load().await;
let dlq = DeadLetterQueue::from_config(config);

for queue_url in dlq.list().await {
    println!("Found queue: {}", queue_url);
}
Source

pub async fn poll(&self, queue_url: &str)

Polls messages from a queue and prints them as JSON.

Continuously receives messages until the queue is empty or the maximum number of attempts (10) is reached. Each message is printed to stdout as a JSON object.

§Arguments
  • queue_url - The URL of the queue to poll messages from
§Example
use dlq::DeadLetterQueue;

let config = aws_config::from_env().load().await;
let dlq = DeadLetterQueue::from_config(config);

// Poll a specific queue
dlq.poll("https://sqs.us-east-1.amazonaws.com/123/my-dlq").await;

Trait Implementations§

Source§

impl Clone for DeadLetterQueue

Source§

fn clone(&self) -> DeadLetterQueue

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

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
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<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