Struct Trx 

pub struct Trx(/* private fields */);

An amount of TRX, stored internally as i64 sun.

User-facing constructors enforce non-negative amounts. Negative values remain representable only so malformed protobuf or serialized data can be inspected and round-tripped without panicking; arithmetic operations reject them.

Implementations

impl Trx

pub const ZERO: Trx

Zero TRX.

pub const fn from_sun(sun: i64) -> Result<Self, AmountError>

Construct from a raw sun value, rejecting negatives.

pub const fn as_sun(self) -> i64

The raw sun value.

pub fn checked_add(self, rhs: Trx) -> Option<Trx>

Checked addition. Returns None on i64 overflow or if either operand is negative.

pub fn checked_sub(self, rhs: Trx) -> Option<Trx>

Checked subtraction. Returns None on i64 overflow, if either operand is negative, or if the result would be negative.

Trait Implementations

impl Add for Trx

fn add(self, rhs: Trx) -> Trx

Panics

Panics on i64 overflow or a negative result. Use Trx::checked_add for a non-panicking alternative.

type Output = Trx

The resulting type after applying the + operator.

impl Clone for Trx

fn clone(&self) -> Trx

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Trx

impl Debug for Trx

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

Formats the value using the given formatter.

impl Default for Trx

fn default() -> Trx

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Trx

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Trx

Formats the amount as a fixed-precision decimal TRX string, exactly (no f64), mirroring alloy’s format_units behavior.

use tronz_primitives::Trx;

assert_eq!(Trx::from_sun(1_500_000).unwrap().to_string(), "1.500000");
assert_eq!("100".parse::<Trx>().unwrap().to_string(), "100.000000");
assert_eq!(Trx::from_sun(1).unwrap().to_string(), "0.000001");
assert_eq!("1.5".parse::<Trx>().unwrap().to_string(), "1.500000");

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

Formats the value using the given formatter.

impl Eq for Trx

impl FromStr for Trx

Parse a decimal TRX string (e.g. "1.5" or "100") into sun.

The accepted syntax mirrors alloy’s parse_units with 6 decimal places: leading decimal points and _ separators are accepted, an empty string is zero, and fractional digits beyond sun precision are truncated. Negative values remain invalid because native TRX amounts are non-negative.

Examples

use tronz_primitives::Trx;

assert_eq!("1".parse::<Trx>().unwrap().as_sun(), 1_000_000);
assert_eq!("1.5".parse::<Trx>().unwrap().as_sun(), 1_500_000);
assert_eq!(".5".parse::<Trx>().unwrap().as_sun(), 500_000);
assert_eq!("0.000001".parse::<Trx>().unwrap().as_sun(), 1);
assert_eq!("1.0000009".parse::<Trx>().unwrap().as_sun(), 1_000_000);
assert!("-1".parse::<Trx>().is_err());

type Err = AmountError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Trx

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Trx

fn cmp(&self, other: &Trx) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Trx

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Trx

fn partial_cmp(&self, other: &Trx) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Trx

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Trx

impl Sub for Trx

fn sub(self, rhs: Trx) -> Trx

Panics

Panics on i64 overflow or a negative result. Use Trx::checked_sub for a non-panicking alternative.

type Output = Trx

The resulting type after applying the - operator.