Struct Unit

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

Ethereum unit. Always less than 77.

Implementations

impl Unit

pub const WEI: Self

Wei is equivalent to 1 wei.

pub const KWEI: Self

Kwei is equivalent to 1e3 wei.

pub const MWEI: Self

Mwei is equivalent to 1e6 wei.

pub const GWEI: Self

Gwei is equivalent to 1e9 wei.

pub const TWEI: Self

Twei is equivalent to 1e12 wei.

pub const PWEI: Self

Pwei is equivalent to 1e15 wei.

pub const ETHER: Self

Ether is equivalent to 1e18 wei.

pub const MIN: Self = Self::WEI

The smallest unit.

pub const MAX: Self

The largest unit.

pub const fn new(units: u8) -> Option<Self>

Creates a new Unit instance, checking for overflow.

pub const unsafe fn new_unchecked(x: u8) -> Self

Creates a new Unit instance.

Safety

x must be less than Unit::MAX.

pub fn wei(self) -> U256

Returns 10^self, which is the number of Wei in this unit.

Examples

use alloy_primitives::{utils::Unit, U256};

assert_eq!(U256::from(1u128), Unit::WEI.wei());
assert_eq!(U256::from(1_000u128), Unit::KWEI.wei());
assert_eq!(U256::from(1_000_000u128), Unit::MWEI.wei());
assert_eq!(U256::from(1_000_000_000u128), Unit::GWEI.wei());
assert_eq!(U256::from(1_000_000_000_000u128), Unit::TWEI.wei());
assert_eq!(U256::from(1_000_000_000_000_000u128), Unit::PWEI.wei());
assert_eq!(U256::from(1_000_000_000_000_000_000u128), Unit::ETHER.wei());

pub const fn wei_const(self) -> U256

Returns 10^self, which is the number of Wei in this unit.

Panics

Panics if 10^self would overflow a u64 (self > 19). If this can happen, use wei instead.

pub const fn get(self) -> u8

Returns the numeric value of the unit.

Trait Implementations

impl Clone for Unit

fn clone(&self) -> Unit

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Unit

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

Formats the value using the given formatter.

impl Display for Unit

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

Formats the value using the given formatter.

impl FromStr for Unit

type Err = UnitsError

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 Ord for Unit

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

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

fn partial_cmp(&self, other: &Unit) -> 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<'a> TryFrom<&'a String> for Unit

type Error = UnitsError

The type returned in the event of a conversion error.

fn try_from(value: &'a String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for Unit

type Error = UnitsError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Unit

type Error = UnitsError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u8> for Unit

type Error = UnitsError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Unit

impl Eq for Unit

impl StructuralPartialEq for Unit

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 1 byte