Struct EtherAmount

pub struct EtherAmount(pub u128);

A wrapper for ether amounts.

Examples

In non-const context, the most idiomatic way to produce a size is to multiply EtherUnit by u128:

let size = 100 * EtherUnit::Gwei;
assert_eq!(size, EtherAmount(100_000_000_000));

In const context, Self::new() may be used instead:

const AMOUNT: EtherAmount = EtherAmount::new(100, EtherUnit::Gwei);
assert_eq!(AMOUNT, EtherAmount(100_000_000_000));

As config param

EtherAmount can be parsed from a string with a unit suffix. See also WithUnit.

let amount: EtherAmount = "123 gwei".parse()?;
assert_eq!(amount, 123 * EtherUnit::Gwei);

// Decimal values are supported. The value conversion is lossless.
let amount: EtherAmount = "0.0013 ether".parse()?;
assert_eq!(amount, 1_300_000 * EtherUnit::Gwei);

// Scientific / exponential notation is supported as well.
let amount: EtherAmount = "2.5e12 wei".parse()?;
assert_eq!(amount, EtherAmount(2_500_000_000_000));

Tuple Fields

0: u128

Implementations

impl EtherAmount

pub const fn checked(val: u128, unit: EtherUnit) -> Option<Self>

Creates a value with the specified unit of measurement checking for overflow.

pub const fn new(val: u128, unit: EtherUnit) -> Self

Creates a value with the specified unit of measurement.

Panics

Panics on overflow.

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

Adds two byte sizes.

pub const fn checked_mul(self, factor: u128) -> Option<Self>

Multiplies this size by the given factor.

Trait Implementations

impl Add for EtherAmount

Panics on overflow.

type Output = EtherAmount

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for EtherAmount

fn clone(&self) -> EtherAmount

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CustomKnownOption for EtherAmount

const OPT_DE: Self::OptDeserializer

Deserializer instance.

type OptDeserializer = Optional<WithUnit, true>

Type of the deserializer used for Option<Self>.

impl Debug for EtherAmount

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

Formats the value using the given formatter.

impl Default for EtherAmount

fn default() -> EtherAmount

Returns the “default value” for a type.

impl DeserializeParam<EtherAmount> for WithUnit

const EXPECTING: BasicTypes = Self::EXPECTED_TYPES

Describes which parameter this deserializer is expecting.

fn describe(&self, description: &mut TypeDescription)

Additional info about the deserialized type, e.g., extended description.

fn deserialize_param( &self, ctx: DeserializeContext<'_>, param: &'static ParamMetadata, ) -> Result<EtherAmount, ErrorWithOrigin>

Performs deserialization given the context and param metadata.

fn serialize_param(&self, param: &EtherAmount) -> Value

Serializes the provided parameter to the JSON model.

impl Display for EtherAmount

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

Formats the value using the given formatter.

impl From<EtherUnit> for EtherAmount

fn from(unit: EtherUnit) -> Self

Converts to this type from the input type.

impl From<u128> for EtherAmount

fn from(value: u128) -> Self

Converts to this type from the input type.

impl FromStr for EtherAmount

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 EtherAmount

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<u128> for EtherAmount

Panics on overflow.

type Output = EtherAmount

The resulting type after applying the * operator.

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

Performs the * operation.

impl Ord for EtherAmount

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

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

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

const DE: Self::Deserializer = WithUnit

Deserializer instance.

type Deserializer = WithUnit

Type of the deserializer used for this type.

impl Copy for EtherAmount

impl Eq for EtherAmount

impl StructuralPartialEq for EtherAmount