Struct xrpl_rs::types::Response

pub struct Response<T> {
    pub id: Option<RequestId>,
    pub status: Option<String>,
    pub type: Option<String>,
    pub result: Result<T>,
    pub warning: Option<String>,
    pub warnings: Option<Vec<Value>>,
    pub forwarded: Option<bool>,
}

Fields

id: Option<RequestId>

(WebSocket only) ID provided in the request that prompted this response

status: Option<String>

(WebSocket only) The value success indicates the request was successfully received and understood by the server. Some client libraries omit this field on success.

type: Option<String>

(WebSocket only) The value response indicates a direct response to an API request. Asynchronous notifications use a different value such as ledgerClosed or transaction.

result: Result<T>

The result of the query; contents vary depending on the command.

warning: Option<String>

(May be omitted) If this field is provided, the value is the string load. This means the client is approaching the rate limiting threshold where the server will disconnect this client.

warnings: Option<Vec<Value>>

(May be omitted) If this field is provided, it contains one or more Warnings Objects with important warnings. For details, see API Warnings. New in: rippled 1.5.0 TODO: Add Warnings Object.

forwarded: Option<bool>

(May be omitted) If true, this request and response have been forwarded from a Reporting Mode server to a P2P Mode server (and back) because the request requires data that is not available in Reporting Mode. The default is false.

Trait Implementations

impl<T: Clone> Clone for Response<T>

fn clone(&self) -> Response<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Response<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Response<T> where
    T: Deserialize<'de>, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for Response<T> where
    T: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.