Enum Onboarding 

pub enum Onboarding {
    Connecting,
    Asking {
        device: String,
    },
    Denied {
        device: String,
    },
    AlreadyPending {
        device: String,
    },
    GaveUp(String),
    Reauthorizing {
        device: String,
        was_expired: bool,
    },
}

Where this device stands on its way to a first delta.

Worth showing to a caller directly: approval can take minutes, and an interface that stays empty in the meantime is indistinguishable from a broken one.

Variants

Connecting

Listening for the server, or opening the connection to one.

Asking

Waiting for a human to approve this device, under the name it asked as.

Fields

device: String

What the administrator will see in the approval list.

Denied

The administrator looked and said no.

Fields

device: String

The name that was refused.

AlreadyPending

The server already holds a request under this name that this run has no way to poll – typically a stray one left over from an earlier run whose own record of it was lost. Unlike Self::Asking, this run will not notice an approval on its own; deciding it on the server clears the way, but this run itself needs a restart to try again after that.

Fields

device: String

The name whose earlier request is being waited on.

GaveUp(String)

Gave up before ever connecting, in log words rather than translated – there is no small set of reasons to enumerate here, only whatever the network or the server said.

Reauthorizing

The token this installation held was refused with 401 Unauthorized, discarded, and a fresh request just went out under the same name.

Fields

device: String

What the fresh request is going out under.

was_expired: bool

Whether the discarded token’s own exp claim said it had already expired, read before it was thrown away. false also covers a token with no expiry claim at all, refused for some other reason – revoked by the administrator, most likely – that only the server’s own log would show; a 401 alone cannot tell the two apart.

Trait Implementations

impl Clone for Onboarding

fn clone(&self) -> Onboarding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Onboarding

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

Formats the value using the given formatter.

impl Eq for Onboarding

impl PartialEq for Onboarding

fn eq(&self, other: &Onboarding) -> 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 Onboarding