Enum LoginEvent 

pub enum LoginEvent<'a> {
    Qr {
        payload: &'a str,
        image_url: Option<&'a str>,
        attempt: Option<u32>,
        max_attempts: Option<u32>,
    },
    PairCode {
        code: &'a str,
    },
    Scanned,
    Expired {
        attempt: u32,
        max_attempts: u32,
    },
    Connected,
    Failed {
        reason: &'a str,
    },
    LoggedOut,
}

A point on the channel-login lifecycle. Construct the variant that matches the flow state and call LoginEvent::emit.

Variants

Qr

A fresh QR code is ready to scan.

Fields

payload: &'a str

Raw payload to encode into a scannable QR image client-side.

image_url: Option<&'a str>

Pre-rendered QR image URL when the platform serves one.

attempt: Option<u32>

Refresh counters when the flow caps QR refreshes (WeChat); None for flows that refresh indefinitely (WhatsApp Web).

max_attempts: Option<u32>

PairCode

A phone-number pair code is ready to type into the app.

Fields

code: &'a str

Scanned

The QR code was scanned; waiting for in-app confirmation.

Expired

The QR code expired; a refresh follows while attempts remain.

Fields

attempt: u32

max_attempts: u32

Connected

Login confirmed — the channel is connected.

Failed

The login flow gave up (attempts exhausted or fatal error).

Fields

reason: &'a str

LoggedOut

A previously linked session was revoked remotely.

Implementations

impl LoginEvent<'_>

pub fn state(&self) -> &'static str

Stable attributes.login.state discriminator for this variant.

pub fn emit(&self, channel_type: &str, channel_alias: &str, message: &str)

Emit this lifecycle point as a structured log event. Live SSE consumers can drive pairing UIs remotely (credentials ride the broadcast-only ephemeral path); JSONL consumers see lifecycle state and identity without the pairing credentials.

Trait Implementations

impl<'a> Debug for LoginEvent<'a>

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

Formats the value using the given formatter.