xrpl_types 0.12.0

Core types and related functions for the XRP Ledger
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

use serde::Serialize;

/// Specification of ledger to retreive data from.
/// See <<https://xrpl.org/basic-data-types.html#specifying-ledgers>
#[derive(Debug, Clone)]
pub enum LedgerSpec {
    LedgerIndex(LedgerIndex),
    LedgerHash(String),
}

/// Specification of ledger to retreive data from by the `ledger_index` property.
/// See <<https://xrpl.org/basic-data-types.html#specifying-ledgers>
#[derive(Debug, Clone, Copy)]
pub enum LedgerIndex {
    Validated,
    Closed,
    Current,
    Index(u32),
}

impl Serialize for LedgerIndex {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        // Encodes the specification as `ledger_index` property value,
        // see <https://xrpl.org/basic-data-types.html#specifying-ledgers>.
        match self {
            LedgerIndex::Validated => serializer.serialize_str("validated"),
            LedgerIndex::Closed => serializer.serialize_str("closed"),
            LedgerIndex::Current => serializer.serialize_str("current"),
            LedgerIndex::Index(index) => serializer.serialize_u32(*index),
        }
    }
}