Enum AuthState 

pub enum AuthState {
    Unauthenticated,
    Challenged {
        challenge_type: ChallengeType,
        challenge_id: String,
    },
    MfaRequired,
    DeviceVerification {
        workflow_id: String,
    },
    Authenticated {
        access_token: SecretString,
        token_type: String,
        refresh_token: SecretString,
    },
}

Represents the current phase of Robinhood authentication.

Transitions follow the pattern: Unauthenticated -> (Challenged | MfaRequired | DeviceVerification) -> Authenticated.

Variants

Unauthenticated

Indicates that no authentication attempt has been made or credentials have been cleared.

Challenged

Indicates the server issued a challenge that must be answered before authentication can proceed.

Fields

challenge_type: ChallengeType

The type of challenge issued (e.g., SMS or email).

challenge_id: String

The server-assigned identifier for this challenge.

MfaRequired

Indicates the server requires a multi-factor authentication code (e.g., TOTP).

DeviceVerification

Indicates the server requires device verification before proceeding.

Fields

workflow_id: String

The server-assigned workflow identifier for the device verification flow.

Authenticated

Indicates successful authentication with valid OAuth tokens.

Fields

access_token: SecretString

The OAuth access token used to authorize API requests.

token_type: String

The token type prefix for the Authorization header (typically "Bearer").

refresh_token: SecretString

The OAuth refresh token used to obtain a new access token when the current one expires.

Implementations

impl AuthState

pub fn is_authenticated(&self) -> bool

Returns true if the state is AuthState::Authenticated.

pub fn authorization_header(&self) -> Option<String>

Returns the formatted Authorization header value (e.g., "Bearer <token>"), or None if the state is not AuthState::Authenticated.

pub fn refresh_token(&self) -> Option<&SecretString>

Returns a reference to the OAuth refresh token, or None if the state is not AuthState::Authenticated.

Trait Implementations

impl Clone for AuthState

fn clone(&self) -> AuthState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthState

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

Formats the value using the given formatter.