Enum RegistrationError 

pub enum RegistrationError {
    AuthRejected(String),
    KeyExpired,
    NeedsLogin(Url),
    NetworkUnreachable,
    Timeout,
}

A typed registration outcome, distinguishing a permanent failure (don’t retry — tell the user) from a transient one (worth retrying).

This is the error surfaced by Runtime::wait_until_running, replacing the previous “poll ipv4_addr until a deadline and report a generic timeout” workaround with an actionable reason.

Variants

AuthRejected(String)

Control rejected registration with a permanent reason — typically a bad, expired, or unknown auth key. The string is control’s verbatim reason. Permanent: re-pairing (a new auth key) is required; retrying with the same key will not succeed.

KeyExpired

The node key has expired. Permanent until re-authentication.

NeedsLogin(Url)

Interactive authorization is required: control offered an auth URL (no usable auth key). Actionable but not permanent — direct the user to the URL; the runtime keeps retrying registration and will reach Running once the user authorizes (so this is not is_permanent). A caller using an auth key should not hit this; a caller doing interactive auth should drive it via watch_state rather than treating this as a hard failure.

NetworkUnreachable

The control plane was unreachable (network/transport error). Transient: retrying later may succeed.

Timeout

No settled state was reached before the caller’s timeout elapsed. Indeterminate: registration may still be in flight (e.g. slow control plane); the caller may retry the wait.

Implementations

impl RegistrationError

pub fn is_permanent(&self) -> bool

Whether this outcome is permanent — re-pairing / new credentials are required and retrying as-is will not succeed (AuthRejected, KeyExpired). Everything else is not permanent: NetworkUnreachable/Timeout are transient (retry may succeed), and NeedsLogin is actionable-but-recoverable (the runtime keeps retrying and reaches Running once the user authorizes the offered URL — so it is not permanent).

Trait Implementations

impl Clone for RegistrationError

fn clone(&self) -> RegistrationError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RegistrationError

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

Formats the value using the given formatter.

impl Display for RegistrationError

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

Formats the value using the given formatter.

impl Eq for RegistrationError

impl Error for RegistrationError

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<&Error> for RegistrationError

Map a control-layer ts_control::Error from the registration path into a typed RegistrationError. Used by the control runner when its check_auth loop hard-fails.

fn from(e: &Error) -> RegistrationError

Converts to this type from the input type.

impl PartialEq for RegistrationError

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for RegistrationError