Enum Error 

#[non_exhaustive]
pub enum Error {
    MissingApiKey,
    InvalidBaseUrl(String),
    MissingArgument(&'static str),
    Api {
        status: u16,
        message: String,
    },
    RateLimited {
        status: u16,
        message: String,
    },
    EmptyResult {
        symbol: String,
        search_query: String,
        endpoint: &'static str,
    },
    EndpointUnavailable {
        endpoint: &'static str,
        message: &'static str,
    },
    Http(Error),
    Json(Error),
}

Errors returned by the FMP CLI and client.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

MissingApiKey

The API key was not provided.

InvalidBaseUrl(String)

The configured base URL is invalid.

MissingArgument(&'static str)

A required CLI argument was not provided.

Api

The API returned a non-successful response.

Fields

status: u16

HTTP status code returned by the API.

message: String

Redacted response body or status message.

RateLimited

The API rate-limited the request.

Fields

status: u16

HTTP status code returned by the API.

message: String

Redacted response body or status message.

EmptyResult

A strict symbol lookup returned no data.

Fields

symbol: String

Symbol or symbol list used for the lookup.

search_query: String

Query suggested for discovery with fmp-agent search.

endpoint: &'static str

API endpoint path that returned the empty payload.

EndpointUnavailable

A CLI command maps to an endpoint that FMP no longer documents for the stable API.

Fields

endpoint: &'static str

Endpoint path or command identifier that is unavailable.

message: &'static str

User-facing explanation of the unavailable endpoint.

Http(Error)

The HTTP client failed before receiving a usable response.

Json(Error)

JSON serialization failed while rendering output.

Implementations

impl Error

pub const fn kind(&self) -> &'static str

Returns a stable machine-readable error kind.

pub fn exit_code(&self) -> ExitCode

Returns a process exit code for this error.

Codes follow a simple convention:

• 2 - usage/argument error (missing required CLI argument)
• 3 - configuration error (missing API key, invalid base URL)
• 4 - network/HTTP error
• 5 - API error (server returned an error response, including rate limits)
• 6 - parse error (JSON deserialization failed)
• 7 - empty symbol result in strict mode

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(error: Error) -> Self

Converts to this type from the input type.