Struct LocalDelivery 

pub struct LocalDelivery<Context: XmtpSharedContext> { /* private fields */ }

One local reader with at most one item awaiting application acknowledgement.

Implementations

impl<Context> LocalDelivery<Context>

where Context: XmtpSharedContext + 'static,

pub fn control(&self) -> LocalDeliveryControl

pub fn close(&mut self)

Close without acknowledging the last item. Its content remains eligible after restart.

pub async fn next_delivery( &mut self, ) -> Result<Option<LocalDeliveryItem<Context>>, LocalDeliveryError>

Return one item with an explicit acknowledgement token for callback and host-queue adapters. The next call waits for that token. It never acknowledges the previous item itself.

pub fn into_stream( self, ) -> impl Stream<Item = Result<StoredGroupMessage, SubscribeError>>

Rust iterator adapter. A new poll acknowledges the previously returned item. Dropping this stream while it is suspended at yield leaves that item unacknowledged.

pub fn into_cursor_stream( self, ) -> impl Stream<Item = Result<DeliveryMessage, LocalDeliveryError>>

Cursor-bearing Rust replay/default iterator with the same acknowledgement boundary.

pub fn enriched_history_snapshot( context: &Context, scope: &DeliveryScope, filter: &LocalDeliveryFilter, limit: u32, ) -> Result<EnrichedDeliverySnapshot, LocalDeliveryError>

Read history, relations, deletions, and its boundary in one database snapshot.

pub fn history_snapshot( context: &Context, scope: &DeliveryScope, filter: &LocalDeliveryFilter, limit: u32, ) -> Result<DeliverySnapshot, LocalDeliveryError>

Read history and its resume boundary in one database snapshot.

Trait Implementations

impl<Context: XmtpSharedContext> Drop for LocalDelivery<Context>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

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

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.