Struct InventoryStream 

pub struct InventoryStream { /* private fields */ }

Cancellable stream of bounded inventory events.

Implementations

impl InventoryStream

pub async fn message(&mut self) -> Option<OpcResult<InventoryEvent>>

Wait for the next inventory event.

A failed inventory is delivered as Some(Err(_)), which is the terminal event for the stream. A successful or cancelled inventory ends with an InventoryEvent::Completed message.

pub fn control(&self) -> InventoryControl

Return a control handle for this inventory.

pub fn cancel(&self)

Request cancellation of this inventory.

pub fn pause(&self)

Pause this inventory before its next bounded operation.

pub fn resume(&self)

Resume this inventory.

Trait Implementations

impl Drop for InventoryStream

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.