Skip to content

Commit

Permalink
Split Delivery method docs into tagline, further paragaphs
Browse files Browse the repository at this point in the history
  • Loading branch information
svix-jplatte committed Feb 6, 2024
1 parent fdef729 commit d5e0c95
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions omniqueue/src/queue/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -64,21 +64,25 @@ pub struct Delivery {
}

impl Delivery {
/// Acknowledges the receipt and successful processing of this [`Delivery`]. The exact nature of
/// this will vary per backend, but usually it ensures that the same message is not reprocessed.
/// Acknowledges the receipt and successful processing of this [`Delivery`].
///
/// The exact nature of this will vary per backend, but usually it ensures that the same message
/// is not reprocessed.
pub async fn ack(&mut self) -> Result<(), QueueError> {
self.acker.ack().await
}

/// Explicitly does not Acknowledge the successful processing of this [`Delivery`]. The exact
/// nature of this will vary by backend, but usually it ensures that the same message is either
/// reinserted into the same queue or is sent to a separate collection.
/// Explicitly does not Acknowledge the successful processing of this [`Delivery`].
///
/// The exact nature of this will vary by backend, but usually it ensures that the same message
/// is either reinserted into the same queue or is sent to a separate collection.
pub async fn nack(&mut self) -> Result<(), QueueError> {
self.acker.nack().await
}

/// This method will deserialize the contained bytes using the configured decoder. If a decoder
/// does not exist for the type parameter T, this function will return an error.
/// This method will deserialize the contained bytes using the configured decoder.
///
/// If a decoder does not exist for the type parameter T, this function will return an error.
///
/// This method does not consume the payload.
pub fn payload_custom<T: 'static>(&self) -> Result<Option<T>, QueueError> {
Expand Down

0 comments on commit d5e0c95

Please sign in to comment.