Struct UnknownPhaseToken 

pub struct UnknownPhaseToken(/* private fields */);

A phase token this build does not recognise, held so it cannot be confused with one it does.

Why the payload is a type and not a bare String

WalletSyncPhase::Unrecognized serializes whatever it holds. With a public String inside, Unrecognized("synced".to_owned()) was constructible by any consumer, reported is_recognized() == false locally, went onto the wire as the bare token "synced", and arrived at the far side as a confident WalletSyncPhase::Synced — a value that claims the wallet is caught up while calling itself unrecognised. It was also the one value in the type that did not round-trip, contradicting the verbatim-carriage guarantee the variant exists to provide.

The field is private and this type has no public constructor, so the only way to reach Unrecognized from outside the crate is WalletSyncPhase::from, which is TOTAL: hand it a known spelling and it returns that known variant instead. The dishonest value is therefore not merely discouraged — it cannot be built.

This is deliberately a type-level guard rather than a documented rule. The whole family exists because a wire-level mismatch went unnoticed until someone built a probe, and a rule that only a doc comment enforces is the same shape of mistake one layer up.

Implementations

impl UnknownPhaseToken

pub fn as_str(&self) -> &str

The token exactly as the node sent it.

Untrusted, node-supplied text: escape and bound it before rendering. Debug escapes it, as String’s always has; this accessor deliberately does not, because a relay has to be able to hand on the exact bytes.

Trait Implementations

impl Clone for UnknownPhaseToken

fn clone(&self) -> UnknownPhaseToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UnknownPhaseToken

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

Formats the value using the given formatter.

impl Display for UnknownPhaseToken

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

The raw token, so it composes in a log line. Same untrusted text as as_str — bound and escape it at the point of display.

impl Eq for UnknownPhaseToken

impl Hash for UnknownPhaseToken

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for UnknownPhaseToken

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for UnknownPhaseToken