Struct zebra_network::peer::client::MustUseClientResponseSender

pub(super) struct MustUseClientResponseSender {
    pub tx: Option<Sender<Result<Response, SharedPeerError>>>,
    pub missing_inv: Option<Box<MissingInventoryCollector>>,
}

A oneshot::Sender for client responses, that must be used by calling send(). Also handles forwarding missing inventory to the inventory registry.

Panics on drop if tx has not been used or canceled. Panics if tx.send() is used more than once.

Fields

tx: Option<Sender<Result<Response, SharedPeerError>>>

The sender for the oneshot client response channel.

None if tx.send() has been used.

missing_inv: Option<Box<MissingInventoryCollector>>

Forwards missing inventory in the response to the inventory collector.

Boxed to reduce the size of containing structures.

Implementations

impl MustUseClientResponseSender

pub fn new( tx: Sender<Result<Response, SharedPeerError>>, request: &Request, inv_collector: Option<Sender<InventoryResponse<(AtLeastOne<InventoryHash>, PeerSocketAddr), (AtLeastOne<InventoryHash>, PeerSocketAddr)>>>, transient_addr: Option<PeerSocketAddr>, ) -> Self

Returns a newly created client response sender for tx.

If request or the response contains missing inventory, it is forwarded to the inv_collector, for the peer at transient_addr.

pub fn send( self, response: Result<Response, SharedPeerError>, ) -> Result<(), Result<Response, SharedPeerError>>

Forwards response to tx.send(), and missing inventory to inv_collector, and marks this sender as used.

Panics if tx.send() is used more than once.

pub fn cancellation( &mut self, ) -> Cancellation<'_, Result<Response, SharedPeerError>>

Returns tx.cancellation().

Panics if tx.send() has previously been used.

pub fn is_canceled(&self) -> bool

Returns tx.is_canceled().

Panics if tx.send() has previously been used.

Trait Implementations

impl Debug for MustUseClientResponseSender

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for MustUseClientResponseSender

fn drop(&mut self)

Executes the destructor for this type.