Enum bitcoin_peerman::State

#[repr(u8)]
pub enum State {
    CANDIDATE_DELAYED,
    CANDIDATE_READY,
    CANDIDATE_BEST,
    REQUESTED,
    COMPLETED,
}

| The various states a (txhash,peer) pair can be | in. | | Note that CANDIDATE is split up into | 3 substates (DELAYED, BEST, READY), allowing | more efficient implementation. Also note that | the sorting order of ByTxHashView relies on the | specific order of values in this enum. | | Expected behaviour is: | | - When first announced by a peer, the state | is CANDIDATE_DELAYED until reqtime is | reached. | | - Announcements that have reached their | reqtime but not been requested will be | either CANDIDATE_READY or | CANDIDATE_BEST. Neither of those has an | expiration time; they remain in that state | until they’re requested or no longer | needed. CANDIDATE_READY announcements are | promoted to CANDIDATE_BEST when they’re the | best one left. | | - When requested, an announcement will be in | state REQUESTED until expiry is reached. | | - If expiry is reached, or the peer replies | to the request (either with NOTFOUND or the | tx), the state becomes COMPLETED.

Variants

CANDIDATE_DELAYED

| A CANDIDATE announcement whose reqtime | is in the future. |

CANDIDATE_READY

| A CANDIDATE announcement that’s not | CANDIDATE_DELAYED or CANDIDATE_BEST. |

CANDIDATE_BEST

| The best CANDIDATE for a given txhash; | only if there is no REQUESTED announcement | already for that txhash. | | The CANDIDATE_BEST is the highest-priority | announcement among all CANDIDATE_READY | (and _BEST) ones for that txhash. |

REQUESTED

| A REQUESTED announcement. |

COMPLETED

| A COMPLETED announcement. |

Trait Implementations

impl Clone for State

fn clone(&self) -> State

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<State> for State

fn eq(&self, other: &State) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<u8> for State

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(x: u8) -> Result<State, Self::Error>

Performs the conversion.

impl Eq for State

impl StructuralEq for State

impl StructuralPartialEq for State