Enum PairError 

#[non_exhaustive]
pub enum PairError {
    PairCode(PairCodeError),
    RequestFailed(IqError),
}

Errors raised by the high-level pair-code flow.

Wraps wacore::pair_code::PairCodeError (validation, key derivation, bundle building) and adds the IQ transport layer via RequestFailed.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

PairCode(PairCodeError)

RequestFailed(IqError)

The pair-code IQ was rejected by the server.

Note the server returns bad-request (400) both for genuinely invalid content and for rate-limiting — it throttles pair-code requests per phone number and reuses the same error. So a 400 here is not necessarily a permanent/invalid-input failure: back off and retry rather than treating every 400 as fatal. (The lib canonicalizes the companion_platform_display OS, so a display-shaped rejection is already ruled out — see wacore::companion_reg::CompanionOs.) Any server backoff hint is preserved on the wrapped IqError.

Renders what it wraps, per the rendering convention — so the code and text reach a log line that only prints the error, without the reader having to reach for the Debug form.

Implementations

impl PairError

pub fn rejection(&self) -> Option<PairCodeRejection>

How the server refused the request, as a status to branch on.

None when nothing was refused: local validation, no connection, or a request that went unanswered. Prefer this to matching the message, which is not a stable surface.

Classified from the code and text together, so a pairing WA Web would not accept yields None rather than the named arm — see PairCodeRejection::from_server. The refused-but-unclassifiable case is therefore indistinguishable here from “nothing was refused”; both mean the same thing to a consumer, which is that there is no typed status to act on and the message is all there is.

pub fn lost_the_flow_to_another_request(&self) -> bool

Whether this request lost the pairing flow to someone else rather than ending it — so its failure says nothing about whether a code arrives.

These are the failures Event::PairingCodeError must stay silent for, because its meaning is “no code is coming” and here that is not what happened:

• PairCodeError::CodeAlreadyOutstanding — refused because an earlier code is still inside its validity window. That code is on screen and may yet be entered; the consumer already has it from the Event::PairingCode that minted it.
• PairCodeError::Cancelled — the caller withdrew this request via Client::cancel_pair_code, and a replacement may already own the slot. Reporting the predecessor would let a consumer read the live replacement as failed and tear down a code that is about to arrive.

Both are consequences of something the caller did, so neither is news to them, and a direct caller still receives the Err either way.

pub fn backoff(&self) -> Option<Duration>

How long the server asked the client to wait before retrying, from the backoff attribute.

Usually None — the server rarely populates it on this request, and WA Web never reads it — but a value here is the server naming its own delay, which beats an interval the consumer picked.

Trait Implementations

impl Debug for PairError

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

Formats the value using the given formatter.

impl Display for PairError

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

Formats the value using the given formatter.

impl Error for PairError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<IqError> for PairError

fn from(source: IqError) -> Self

Converts to this type from the input type.

impl From<PairCodeError> for PairError

fn from(source: PairCodeError) -> Self

Converts to this type from the input type.