Skip to main content

Currency

Struct Currency 

Source
#[repr(C)]
pub struct Currency(pub [u8; 20]);
Expand description

Represents a currency code in the XRPL, which is a 20-byte identifier.

Currency codes in XRPL can be either:

  • Standard currencies: 3-character ASCII codes (e.g., “USD”, “EUR”) stored in bytes 12-14
  • Non-standard currencies: Full 20-byte hex values for custom tokens

§Derived Traits

  • Copy: Efficient for this 20-byte struct, enabling implicit copying
  • PartialEq, Eq: Enable comparisons and use in hash-based collections
  • Debug, Clone: Standard traits for development and consistency

Tuple Fields§

§0: [u8; 20]

Implementations§

Source§

impl Currency

Source

pub fn new(code: [u8; 20]) -> Self

Creates a new Currency from a 20-byte array.

Source

pub fn as_bytes(&self) -> &[u8; 20]

Gets the raw bytes of the Currency.

Trait Implementations§

Source§

impl Clone for Currency

Source§

fn clone(&self) -> Currency

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Currency

Source§

impl Debug for Currency

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for Currency

Source§

impl FieldDecoder for Currency

FieldDecoder for XRPL currency codes: decodes a 20-byte buffer into a Currency, failing if the host wrote a different number of bytes.

Source§

type Buffer = [u8; 20]

The buffer a get_field caller allocates before invoking the host function. Each type picks its own size (an associated type, not a const, so this stays on stable Rust).
Source§

fn empty_buffer() -> Self::Buffer

Returns a zero-initialized buffer of this type’s Buffer size.
Source§

fn decode(buf: Self::Buffer, bytes_written: usize) -> Result<Self, DecodeError>

Decodes Self from the full Buffer (as written by the host, then zero-padded to the buffer’s size), given bytes_written — the number of bytes the host actually wrote. Read more
Source§

impl From<[u8; 3]> for Currency

Source§

fn from(bytes: [u8; 3]) -> Self

Converts to this type from the input type.
Source§

impl From<[u8; 20]> for Currency

Source§

fn from(value: [u8; 20]) -> Self

Converts to this type from the input type.
Source§

impl FromLedger for Currency

Source§

impl PartialEq for Currency

Source§

fn eq(&self, other: &Currency) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Currency

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Any for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

§

fn type_name(&self) -> &'static str

§

impl<T> AnySync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.