Struct IterativeLookup 

pub struct IterativeLookup<N>
where
    N: LookupNode,
{ /* private fields */ }

Pull-based, transport-independent Kademlia lookup state machine.

Implementations

impl<N> IterativeLookup<N>

where N: LookupNode,

pub fn new( target: [u8; 32], config: LookupConfig, ) -> Result<IterativeLookup<N>, LookupError>

Construct an empty lookup for target.

pub const fn target(&self) -> [u8; 32]

Target key for this lookup.

pub const fn config(&self) -> LookupConfig

Active lookup configuration.

pub const fn iterations(&self) -> usize

Number of rounds begun so far.

pub const fn termination(&self) -> Option<LookupTermination>

Current terminal state, if the lookup has stopped.

pub const fn round_active(&self) -> bool

Whether a transport round is currently active.

pub fn peer_state(&self, peer: &[u8; 32]) -> Option<LookupPeerState>

State currently assigned to a peer.

pub fn is_contactable(&self, peer: &[u8; 32]) -> bool

Whether the peer has never been contacted by this lookup.

pub fn queried_peers(&self) -> &[[u8; 32]]

Peers selected for a transport query, in query order.

pub fn add_known_result(&mut self, node: N)

Add a successful result that must never be queried, such as the local node competing in a native lookup’s final XOR ordering.

pub fn add_candidate(&mut self, node: N) -> CandidateInsertion

Add or update an unqueried candidate.

pub fn begin_round(&mut self) -> Result<LookupProgress, LookupError>

Begin the next α-query round.

pub fn take_next_candidate(&mut self) -> Result<Option<N>, LookupError>

Remove and return the closest candidate for the active round.

The driver must either call Self::mark_waiting for the returned node or discard it as temporarily ineligible before asking for another.

pub fn mark_waiting(&mut self, node: N) -> Result<(), LookupError>

Mark a selected node as an in-flight query in the active round.

pub fn record_success(&mut self, peer: &[u8; 32]) -> Result<(), LookupError>

Record a successful response and retain the queried peer as a result.

pub fn record_failure(&mut self, peer: &[u8; 32]) -> Result<(), LookupError>

Record an explicit query or transport failure.

pub fn record_unresponsive( &mut self, peer: &[u8; 32], ) -> Result<(), LookupError>

Record a query abandoned after the transport’s round grace period.

pub fn waiting_peers(&self) -> Vec<[u8; 32]>

Peers still waiting in the active round, in XOR order.

pub fn complete_round(&mut self) -> Result<LookupProgress, LookupError>

Complete the current round and evaluate native Saorsa convergence.

pub fn results(&self) -> Vec<N>

Successful responders sorted closest-first and truncated to K.

Trait Implementations

impl<N> Debug for IterativeLookup<N>

where N: Debug + LookupNode,

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

Formats the value using the given formatter.