docs: Tweak comments on Mailbox (#3152)

pull/24376/head
Andrew Lamb 2021-11-18 09:19:19 -05:00 committed by GitHub
parent 1fae3559cf
commit 5e7336b475
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 4 deletions

View File

@ -10,16 +10,15 @@ use std::sync::Arc;
/// * Allows data to continue to arrive whilst data is being consumed
/// * Allows multiple consumers to coordinate preventing concurrent consumption
///
/// This is different than a tokio channel in the following ways:
/// This is different from a tokio channel in the following ways:
///
/// 1. The contents can be inspected prior to remval from the mailbox
/// 1. The contents can be inspected prior to removal from the mailbox
/// (important as catalog transactions are fallible)
///
/// 2. Potentially multiple consumers can acquire exclusive access for
/// the duration of a catalog transaction
///
/// 3. Users can ensure that everything in the mailbox is
/// consumed
/// 3. Users can ensure that everything in the mailbox is consumed
///
#[derive(Debug)]
pub struct Mailbox<T> {