Struct Balance 

pub struct Balance { /* private fields */ }

Balance representation for Bittensor tokens

Internally stored as RAO (the smallest unit) for precision.

Example

use bittensor_rs::types::Balance;

// Create from TAO
let balance = Balance::from_tao(1.5);
assert_eq!(balance.as_tao(), 1.5);
assert_eq!(balance.as_rao(), 1_500_000_000);

// Create from RAO
let balance2 = Balance::from_rao(500_000_000);
assert_eq!(balance2.as_tao(), 0.5);

Implementations

impl Balance

pub const fn zero() -> Self

Create a zero balance

Example

use bittensor_rs::types::Balance;

let zero = Balance::zero();
assert_eq!(zero.as_rao(), 0);
assert!(zero.is_zero());

pub const fn from_rao(rao: u64) -> Self

Create a balance from RAO (smallest unit)

Example

use bittensor_rs::types::Balance;

let balance = Balance::from_rao(1_000_000_000);
assert_eq!(balance.as_tao(), 1.0);

pub fn from_tao(tao: f64) -> Self

Create a balance from TAO

Example

use bittensor_rs::types::Balance;

let balance = Balance::from_tao(2.5);
assert_eq!(balance.as_rao(), 2_500_000_000);

pub const fn as_rao(&self) -> u64

Get the balance in RAO

Example

use bittensor_rs::types::Balance;

let balance = Balance::from_tao(1.0);
assert_eq!(balance.as_rao(), 1_000_000_000);

pub fn as_tao(&self) -> f64

Get the balance in TAO

Example

use bittensor_rs::types::Balance;

let balance = Balance::from_rao(1_500_000_000);
assert_eq!(balance.as_tao(), 1.5);

pub const fn is_zero(&self) -> bool

Check if the balance is zero

Example

use bittensor_rs::types::Balance;

assert!(Balance::zero().is_zero());
assert!(!Balance::from_tao(1.0).is_zero());

pub fn saturating_add(self, other: Self) -> Self

Saturating addition (returns MAX on overflow instead of panicking)

Example

use bittensor_rs::types::Balance;

let a = Balance::from_tao(1.0);
let b = Balance::from_tao(2.0);
let sum = a.saturating_add(b);
assert_eq!(sum.as_tao(), 3.0);

pub fn saturating_sub(self, other: Self) -> Self

Saturating subtraction (returns 0 on underflow instead of panicking)

Example

use bittensor_rs::types::Balance;

let a = Balance::from_tao(1.0);
let b = Balance::from_tao(2.0);
let diff = a.saturating_sub(b);
assert!(diff.is_zero());

pub fn checked_add(self, other: Self) -> Option<Self>

Checked addition (returns None on overflow)

Example

use bittensor_rs::types::Balance;

let a = Balance::from_tao(1.0);
let b = Balance::from_tao(2.0);
let sum = a.checked_add(b).unwrap();
assert_eq!(sum.as_tao(), 3.0);

pub fn checked_sub(self, other: Self) -> Option<Self>

Checked subtraction (returns None on underflow)

Example

use bittensor_rs::types::Balance;

let a = Balance::from_tao(1.0);
let b = Balance::from_tao(2.0);
assert!(a.checked_sub(b).is_none());

Trait Implementations

impl Add for Balance

type Output = Balance

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Balance

fn add_assign(&mut self, other: Self)

Performs the += operation.

impl Clone for Balance

fn clone(&self) -> Balance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Balance

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

Formats the value using the given formatter.

impl Default for Balance

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Balance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Balance

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

Formats the value using the given formatter.

impl Div<u64> for Balance

type Output = Balance

The resulting type after applying the / operator.

fn div(self, rhs: u64) -> Self

Performs the / operation.

impl From<Balance> for u64

fn from(balance: Balance) -> u64

Converts to this type from the input type.

impl From<u64> for Balance

fn from(rao: u64) -> Self

Converts to this type from the input type.

impl Hash for Balance

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 Mul<u64> for Balance

type Output = Balance

The resulting type after applying the * operator.

fn mul(self, rhs: u64) -> Self

Performs the * operation.

impl Ord for Balance

fn cmp(&self, other: &Balance) -> 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 Balance

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Balance

fn partial_cmp(&self, other: &Balance) -> 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 Balance

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub for Balance

type Output = Balance

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Balance

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Copy for Balance

impl Eq for Balance

impl StructuralPartialEq for Balance