Enum FinamError 

pub enum FinamError {
    Status {
        code: Code,
        message: String,
    },
    Config(String),
    Auth(String),
}

Error of the Finam protocol layer: a gRPC status, a configuration problem or a refused login.

The Display text never contains the API secret or a token.

Examples

use brokapi_finam_protocol::FinamError;
use tonic::Code;

let err = FinamError::from(tonic::Status::new(Code::ResourceExhausted, "too many requests"));
assert_eq!(err.code(), Some(Code::ResourceExhausted));
assert!(err.is_rate_limited());
// The server said "no" before doing anything: a command was not applied.
assert!(err.is_definite_rejection());

// A dropped connection may have happened after the request was written.
let lost = FinamError::from(tonic::Status::new(Code::Unavailable, "connection reset"));
assert!(!lost.is_definite_rejection());

Variants

Status

gRPC status returned by the server (or synthesized by the transport).

Fields

code: Code

gRPC status code. A failed connection also arrives as a status, the code depends on the failure.

message: String

Text sent by the server (or made up by the transport layer).

Config(String)

Bad endpoint, empty secret, malformed token payload.

Auth(String)

Authentication failed (bad secret, token refused).

Implementations

impl FinamError

pub fn code(&self) -> Option<Code>

gRPC status code, or None for FinamError::Config and FinamError::Auth.

pub fn is_unauthenticated(&self) -> bool

true for status UNAUTHENTICATED: the JWT is missing, wrong or expired.

A read may renew the token and repeat. A command must not be repeated automatically.

pub fn is_rate_limited(&self) -> bool

true for status RESOURCE_EXHAUSTED: the request quota is spent and the request was not run.

pub fn is_definite_rejection(&self) -> bool

The server certainly did not process the request (so a command was NOT applied).

Conservative: Unavailable is NOT here, because a connection can drop after the request was written. For commands every other failure is an unknown outcome.

Trait Implementations

impl Clone for FinamError

fn clone(&self) -> FinamError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FinamError

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

Formats the value using the given formatter.

impl Display for FinamError

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

Formats the value using the given formatter.

impl Error for FinamError

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<Status> for FinamError

fn from(s: Status) -> Self

Converts to this type from the input type.