Struct ergo_lib::chain::ergo_box::BoxValue

pub struct BoxValue(_);

Box value in nanoERGs with bound checks

Implementations

impl BoxValue

pub const MIN_VALUE_PER_BOX_BYTE: u32

Minimal box value per byte of the serialized box that was set on on launch

pub const MIN_RAW: u64

Absolute minimal value, calculated from smallest possible box size and original value per byte requirement

pub const MAX_RAW: u64

Absolute maximal allowed box value

pub const MIN: BoxValue

Absolute minimal value, calculated from smallest possible box size and original value per byte requirement

pub const SAFE_USER_MIN: BoxValue

Recommended (safe) minimal box value to use in case box size estimation is unavailable. Allows box size up to 2777 bytes with current min box value per byte of 360 nanoERGs

pub const UNITS_PER_ERGO: u32

Number of units inside one ERGO (i.e. one ERG using nano ERG representation)

pub fn new(v: u64) -> Result<BoxValue, BoxValueError>

create from u64 with bounds check

pub const fn within_bounds(v: u64) -> bool

Check if a value is in bounds

pub fn as_u64(&self) -> &u64

Get the value as u64

pub fn as_i64(&self) -> i64

Get the value as i64

pub fn checked_add(&self, rhs: &Self) -> Result<Self, BoxValueError>

Addition with overflow check

pub fn checked_sub(&self, rhs: &Self) -> Result<Self, BoxValueError>

Subtraction with overflow and bounds check

pub fn checked_mul(&self, rhs: &Self) -> Result<Self, BoxValueError>

Multiplication with overflow check

pub fn checked_mul_u32(&self, rhs: u32) -> Result<Self, BoxValueError>

Multiplication with overflow check

Trait Implementations

impl Clone for BoxValue

pub fn clone(&self) -> BoxValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for BoxValue

impl Debug for BoxValue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BoxValue

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for BoxValue

impl From<BoxValue> for Constant

pub fn from(v: BoxValue) -> Self

Performs the conversion.

impl Hash for BoxValue

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<BoxValue> for BoxValue

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<BoxValue> for BoxValue

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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

impl Serialize for BoxValue

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

Serialize this value into the given Serde serializer.

impl SigmaSerializable for BoxValue

pub fn sigma_serialize<W: WriteSigmaVlqExt>(
    &self,
    w: &mut W
) -> Result<(), Error>

Write self to the given writer. This function has a sigma_ prefix to alert the reader that the serialization in use is consensus-critical serialization
Notice that the error type is std::io::Error; this indicates that serialization MUST be infallible up to errors in the underlying writer. In other words, any type implementing SigmaSerializable must make illegal states unrepresentable.

pub fn sigma_parse<R: SigmaByteRead>(
    r: &mut R
) -> Result<Self, SerializationError>

Try to read self from the given reader. sigma- prefix to alert the reader that the serialization in use is consensus-critical

pub fn sigma_serialize_bytes(&self) -> Vec<u8>

Serialize any SigmaSerializable value into bytes

pub fn sigma_parse_bytes(mut bytes: Vec<u8>) -> Result<Self, SerializationError>

Parse self from the bytes

impl StructuralEq for BoxValue

impl StructuralPartialEq for BoxValue

impl TryFrom<i64> for BoxValue

type Error = BoxValueError

The type returned in the event of a conversion error.

pub fn try_from(v: i64) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u64> for BoxValue

type Error = BoxValueError

The type returned in the event of a conversion error.

pub fn try_from(v: u64) -> Result<Self, Self::Error>

Performs the conversion.