Enum QueryInfo

pub enum QueryInfo {
    Bootstrap {
        peer: PeerId,
        remaining: Option<IntoIter<Key<PeerId>>>,
        step: ProgressStep,
    },
    GetClosestPeers {
        key: Vec<u8>,
        step: ProgressStep,
        num_results: Option<NonZero<usize>>,
    },
    GetProviders {
        key: Key,
        providers_found: usize,
        step: ProgressStep,
    },
    AddProvider {
        key: Key,
        phase: AddProviderPhase,
        context: AddProviderContext,
    },
    PutRecord {
        record: Record,
        quorum: NonZero<usize>,
        phase: PutRecordPhase,
        context: PutRecordContext,
    },
    GetRecord {
        key: Key,
        step: ProgressStep,
        found_a_record: bool,
        cache_candidates: BTreeMap<Distance, PeerId>,
    },
}

Available on crate feature kad only.

Information about a running query.

Variants

Bootstrap

A query initiated by Behaviour::bootstrap.

Fields

peer: PeerId

The targeted peer ID.

remaining: Option<IntoIter<Key<PeerId>>>

The remaining random peer IDs to query, one per bucket that still needs refreshing.

This is None if the initial self-lookup has not yet completed and Some with an exhausted iterator if bootstrapping is complete.

step: ProgressStep

GetClosestPeers

A (repeated) query initiated by Behaviour::get_closest_peers.

Fields

key: Vec<u8>

The key being queried (the preimage).

step: ProgressStep

Current index of events.

num_results: Option<NonZero<usize>>

If required, num_results specifies expected responding peers

GetProviders

A (repeated) query initiated by Behaviour::get_providers.

Fields

key: Key

The key for which to search for providers.

providers_found: usize

The number of providers found so far.

step: ProgressStep

Current index of events.

AddProvider

A (repeated) query initiated by Behaviour::start_providing.

Fields

key: Key

The record key.

phase: AddProviderPhase

The current phase of the query.

context: AddProviderContext

The execution context of the query.

PutRecord

A (repeated) query initiated by Behaviour::put_record.

Fields

record: Record

quorum: NonZero<usize>

The expected quorum of responses w.r.t. the replication factor.

phase: PutRecordPhase

The current phase of the query.

context: PutRecordContext

The execution context of the query.

GetRecord

A (repeated) query initiated by Behaviour::get_record.

Fields

key: Key

The key to look for.

step: ProgressStep

Current index of events.

found_a_record: bool

Did we find at least one record?

cache_candidates: BTreeMap<Distance, PeerId>

The peers closest to the key that were queried but did not return a record, i.e. the peers that are candidates for caching the record.

Trait Implementations

impl Clone for QueryInfo

fn clone(&self) -> QueryInfo

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QueryInfo

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

Formats the value using the given formatter.