Struct AuthTracker 

pub struct AuthTracker { /* private fields */ }

Generic authentication state tracker for WebSocket connections.

Coordinates authentication attempts by providing a channel-based signaling mechanism. Each authentication attempt receives a dedicated oneshot channel that will be resolved when the server responds.

Superseding Behavior

If a new authentication attempt begins while a previous one is pending, the old attempt is automatically cancelled with an error. This prevents auth response race conditions during rapid reconnections.

Thread Safety

All operations are thread-safe and can be called concurrently from multiple tasks.

Implementations

impl AuthTracker

pub fn new() -> Self

Creates a new authentication tracker.

pub fn begin(&self) -> AuthResultReceiver

Begins a new authentication attempt.

Returns a receiver that will be notified when authentication completes. If a previous authentication attempt is still pending, it will be cancelled with an error message indicating it was superseded.

pub fn succeed(&self)

Marks the current authentication attempt as successful.

Notifies the waiting receiver with Ok(()). This should be called when the server sends a successful authentication response.

If no authentication attempt is pending, this is a no-op.

pub fn fail(&self, error: impl Into<String>)

Marks the current authentication attempt as failed.

Notifies the waiting receiver with Err(message). This should be called when the server sends an authentication error response.

If no authentication attempt is pending, this is a no-op.

pub async fn wait_for_result<E>( &self, timeout: Duration, receiver: AuthResultReceiver, ) -> Result<(), E>

where E: From<String>,

Waits for the authentication result with a timeout.

Returns Ok(()) if authentication succeeds, or an error if it fails, times out, or the channel is closed.

Type Parameters

• E: Error type that implements From<String> for error message conversion

Errors

Returns an error in the following cases:

• Authentication fails (server rejects credentials)
• Authentication times out (no response within timeout duration)
• Authentication channel closes unexpectedly
• Authentication attempt is superseded by a new attempt

Trait Implementations

impl Clone for AuthTracker

fn clone(&self) -> AuthTracker

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthTracker

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

Formats the value using the given formatter.

impl Default for AuthTracker

fn default() -> Self

Returns the “default value” for a type.