Struct Hbar 

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

A quantity of hbar.

Implementations

impl Hbar

pub const ZERO: Hbar

A constant value of 0 ℏ.

pub const MIN: Hbar

The minimum allowable amount of hbar -50 Gℏ

pub const MAX: Self

The maximum allowable amount of hbar 50 Gℏ.

pub const fn new(amount: i64) -> Self

Create a Hbar containing amount ℏ.

Examples

let hbar = Hbar::new(52);
assert_eq!(hbar.to_string(), "52 ℏ");

pub const fn from_tinybars(tinybars: Tinybar) -> Self

Convert from tinybars to Hbar.

Examples

let hbar = Hbar::from_tinybars(250);
assert_eq!(hbar.to_string(), "250 tℏ");

pub fn from_unit<T>(amount: T, unit: HbarUnit) -> Self

where T: Into<Decimal>,

Convert from amount in unit to Hbar.

Truncates amount to the nearest tinybar if the resulting Hbar is not an integer amount of tinybar.

Panics

• if amount * unit.tinybars() would overflow a i64.

Examples

use hiero_sdk::Hbar;
use hiero_sdk::HbarUnit;
let value = Hbar::from_unit(20, HbarUnit::Millibar);
assert_eq!(value.to_string(), "0.02 ℏ");

pub const fn to_tinybars(self) -> Tinybar

Returns the value of self in Tinybars.

pub fn to(self, unit: HbarUnit) -> Decimal

Returns self as Decimal units.

pub fn get_value(self) -> Decimal

Returns self as Decimal hbars.

Examples

use rust_decimal::Decimal;
use hiero_sdk::Hbar;
let value: Hbar = "20 mℏ".parse().unwrap();

let value_decimal: Decimal = "0.02".parse().unwrap();

assert_eq!(value.get_value(), value_decimal);

pub fn negated(self) -> Self

Returns -self.

Trait Implementations

impl Add for Hbar

type Output = Hbar

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign for Hbar

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Hbar

fn clone(&self) -> Hbar

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Hbar

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

Formats the value using the given formatter.

impl Default for Hbar

fn default() -> Hbar

Returns the “default value” for a type.

impl Display for Hbar

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

Formats the value using the given formatter.

impl<T> Div<T> for Hbar

where i64: Div<T, Output = i64>,

type Output = Hbar

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<T> DivAssign<T> for Hbar

where i64: DivAssign<T>,

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl From<Decimal> for Hbar

fn from(hbars: Decimal) -> Self

Converts to this type from the input type.

impl From<Hbar> for Decimal

fn from(hbar: Hbar) -> Self

Converts to this type from the input type.

impl FromStr for Hbar

type Err = Error

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 Hbar

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<T> Mul<T> for Hbar

where i64: Mul<T, Output = i64>,

type Output = Hbar

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<T> MulAssign<T> for Hbar

where i64: MulAssign<T>,

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl Neg for Hbar

type Output = Hbar

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Ord for Hbar

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

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

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

type Output = Hbar

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign for Hbar

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Hbar

impl Eq for Hbar

impl StructuralPartialEq for Hbar