From d5e0c95c884839f4f8dc56e4654b58bc15b90332 Mon Sep 17 00:00:00 2001 From: Jonas Platte Date: Tue, 6 Feb 2024 09:56:31 +0100 Subject: [PATCH] Split Delivery method docs into tagline, further paragaphs --- omniqueue/src/queue/mod.rs | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/omniqueue/src/queue/mod.rs b/omniqueue/src/queue/mod.rs index a66a712..cb54261 100644 --- a/omniqueue/src/queue/mod.rs +++ b/omniqueue/src/queue/mod.rs @@ -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(&self) -> Result, QueueError> {