Enum RhoodError 

pub enum RhoodError {
    NotAuthenticated,
    ChallengeRequired(ChallengeType),
    TokenExpired,
    Api {
        status: u16,
        message: String,
    },
    RateLimited {
        retry_after_secs: u64,
    },
    InvalidSymbol(String),
    InvalidParameter(String),
    ReadOnlyMode,
    InvalidOrder(String),
    DeviceVerificationRequired,
    Http(Error),
    Json(Error),
    Io(Error),
    Timeout(String),
}

Errors that can occur when interacting with the Robinhood API.

Example

use rhood_core::{RobinhoodClient, RhoodError};

let client = RobinhoodClient::new()?;
match client.login(username, password, None).await {
    Ok(()) => println!("authenticated"),
    Err(RhoodError::ChallengeRequired(challenge_type)) => {
        println!("verification needed via {challenge_type}");
    }
    Err(RhoodError::DeviceVerificationRequired) => {
        println!("run `rhood login` interactively first");
    }
    Err(other) => return Err(other),
}

Variants

NotAuthenticated

The client is not authenticated and cannot make API calls.

ChallengeRequired(ChallengeType)

The server issued an authentication challenge that must be answered.

TokenExpired

The access token has expired and automatic refresh failed.

Api

The Robinhood API returned a non-success HTTP status.

Fields

status: u16

HTTP status code from the API response.

message: String

Sanitized API diagnostic or locally constructed error context.

RateLimited

The API returned HTTP 429, indicating the client should back off.

Fields

retry_after_secs: u64

Suggested number of seconds to wait before retrying.

InvalidSymbol(String)

The requested ticker symbol was not found.

InvalidParameter(String)

A parameter provided to an API method was invalid.

ReadOnlyMode

A write operation was attempted while the client is in read-only mode.

InvalidOrder(String)

An order request contains invalid or contradictory parameters.

DeviceVerificationRequired

Device verification is required before the client can authenticate.

Http(Error)

An HTTP transport error from the underlying HTTP client.

Json(Error)

A JSON serialization or deserialization error.

Io(Error)

A filesystem I/O error.

Timeout(String)

An operation timed out waiting for a response or approval.

Trait Implementations

impl Debug for RhoodError

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

Formats the value using the given formatter.

impl Display for RhoodError

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

Formats the value using the given formatter.

impl Error for RhoodError

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 RhoodError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for RhoodError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for RhoodError

fn from(source: Error) -> Self

Converts to this type from the input type.