RosettaError class

Instead of utilizing HTTP status codes to describe node errors (which often do not have a good analog), rich errors are returned using this object. Both the code and message fields can be individually used to correctly identify an error. Implementations MUST use unique values for both fields.

Constructors

RosettaError(int code, String message, bool retriable, String? description, Map<String, dynamic>? details)
RosettaError.fromMap(Map<String, dynamic> map)
factory

Properties

code ↔ int
Code is a network-specific error code. If desired, this code can be equivalent to an HTTP status code.
getter/setter pair
description ↔ String?
Description allows the implementer to optionally provide additional information about an error. In many cases, the content of this field will be a copy-and-paste from existing developer documentation. Description can ONLY be populated with generic information about a particular type of error. It MUST NOT be populated with information about a particular instantiation of an error (use details for this). Whereas the content of Error.Message should stay stable across releases, the content of Error.Description will likely change across releases (as implementers improve error documentation). For this reason, the content in this field is not part of any type assertion (unlike Error.Message).
getter/setter pair
details ↔ Map<String, dynamic>?
Often times it is useful to return context specific to the request that caused the error (i.e. a sample of the stack trace or impacted account) in addition to the standard error message.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
message ↔ String
Message is a network-specific error message. The message MUST NOT change for a given code. In particular, this means that any contextual information should be included in the details field.
getter/setter pair
retriable ↔ bool
An error is retriable if the same request may succeed if submitted again.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited