Struct DocumentPublicationReceipt 

pub struct DocumentPublicationReceipt { /* private fields */ }

Completion of the document prefix preceding one publication barrier.

Success means the transport finished publishing that prefix. It does not acknowledge peer observation, CRDT application or durability.

Implementations

impl DocumentPublicationReceipt

pub fn new( receiver: Receiver<Result<(), DocumentPublicationError>>, ) -> DocumentPublicationReceipt

Wrap the receiving half a transport resolves exactly once.

pub fn with_disconnect_cause( self, cause: impl Fn() -> Option<DocumentPublicationError> + Send + 'static, ) -> DocumentPublicationReceipt

Report cause instead of DocumentPublicationError::WorkerStopped when the transport drops this receipt unresolved.

pub fn try_complete(&self) -> Result<Option<()>, DocumentPublicationError>

Inspect completion without waiting. A completed receipt is consumed.

Errors

Returns the prefix failure, or the transport’s disconnection cause when it dropped the receipt unresolved.

pub fn wait( self, deadline: Option<Instant>, ) -> Result<(), DocumentPublicationError>

Wait for completion, optionally within an absolute deadline. A completed result takes precedence over an elapsed deadline.

Errors

Returns a publication failure, the transport stopping, or the deadline elapsing.