Struct NeoInteger 

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

Neo N3 Integer type (arbitrary precision)

Implementations

impl NeoInteger

pub const MAX_BYTE_LENGTH: usize = 32

Maximum byte length of an integer the NeoVM will hold (ExecutionEngineLimits.MaxIntegerSize in C# neo-project/neo — 32 bytes / 256 bits, two’s-complement). The VM FAULTs when an operation produces an integer wider than this.

pub fn new<T>(value: T) -> NeoInteger

where T: Into<BigInt>,

pub fn zero() -> NeoInteger

pub fn one() -> NeoInteger

pub fn fits_in_neovm(&self) -> bool

Whether this value fits within the NeoVM’s 256-bit integer bound.

Host-mode arithmetic on NeoInteger is arbitrary-precision, so a computation that overflows 256 bits succeeds off-chain but FAULTs on-chain. Call this on values derived from untrusted input or unbounded accumulation to detect the divergence before it reaches the VM. Zero is one byte in num-bigint’s representation but is trivially within bounds.

pub fn try_div(&self, rhs: &NeoInteger) -> Result<NeoInteger, NeoError>

Checked division: returns Err(DivisionByZero) instead of panicking (the Div operator faults on a zero divisor — on-chain that becomes a VM FAULT reverting the whole transaction). Use this in any contract path that cannot guarantee a non-zero divisor (D5).

pub fn try_rem(&self, rhs: &NeoInteger) -> Result<NeoInteger, NeoError>

Checked remainder: returns Err(DivisionByZero) instead of panicking (see try_div). Matches the Rem operator’s fault-on-zero behaviour.

pub fn min_i32() -> NeoInteger

pub fn max_i32() -> NeoInteger

pub fn as_bigint(&self) -> &BigInt

pub fn to_bigint(&self) -> BigInt

Owned BigInt (clones the inner BigInt). Use this when you need to keep the value past the NeoInteger’s lifetime (e.g. pass to an API that expects BigInt by value).

pub fn from_bigint(value: &BigInt) -> NeoInteger

Construct a NeoInteger from a BigInt. The From<BigInt> impl already provides this, but spelled as a method for uniformity with to_bigint and for code that has the BigInt behind a reference.

pub fn try_as_i32(&self) -> Option<i32>

Convert to i32, returning None if the value is out of range. This is the safe alternative to as_i32() that doesn’t panic.

pub fn try_as_u32(&self) -> Option<u32>

Convert to u32, returning None if the value is out of range. This is the safe alternative to as_u32() that doesn’t panic.

pub fn try_as_i64(&self) -> Option<i64>

Convert to i64, returning None if the value is out of range.

pub fn try_as_u64(&self) -> Option<u64>

Convert to u64, returning None if the value is out of range.

pub fn try_into_i32(&self) -> Result<i32, NeoError>

Convert to i32, returning Result for ergonomic ? usage.

pub fn try_into_u32(&self) -> Result<u32, NeoError>

Convert to u32, returning Result for ergonomic ? usage.

pub fn try_into_i64(&self) -> Result<i64, NeoError>

Convert to i64, returning Result for ergonomic ? usage.

pub fn try_into_u64(&self) -> Result<u64, NeoError>

Convert to u64, returning Result for ergonomic ? usage.

pub fn as_i32_saturating(&self) -> i32

Convert to i32, saturating at the boundaries if the value is out of range. This never panics.

pub fn as_u32_saturating(&self) -> u32

Convert to u32, saturating at the boundaries if the value is out of range. This never panics.

pub fn as_i64_saturating(&self) -> i64

Convert to i64, saturating at the boundaries if the value is out of range. This never panics.

pub fn as_i32(&self) -> i32

👎Deprecated since 0.1.0:

Use try_as_i32() or as_i32_saturating() explicitly

Deprecated compatibility helper that converts to i32 using saturating semantics.

pub fn as_u32(&self) -> u32

👎Deprecated since 0.1.0:

Use try_as_u32() or as_u32_saturating() explicitly

Deprecated compatibility helper that converts to u32 using saturating semantics.

pub fn to_i32(&self) -> Option<i32>

👎Deprecated since 0.1.0:

Use try_as_i32() instead

Deprecated: use try_as_i32() instead.

pub fn to_u32(&self) -> Option<u32>

👎Deprecated since 0.1.0:

Use try_as_u32() instead

Deprecated: use try_as_u32() instead.

pub fn to_i64(&self) -> Option<i64>

👎Deprecated since 0.1.0:

Use try_as_i64() instead

Deprecated: use try_as_i64() instead.

Trait Implementations

impl Add for NeoInteger

type Output = NeoInteger

The resulting type after applying the + operator.

fn add(self, rhs: NeoInteger) -> <NeoInteger as Add>::Output

Performs the + operation.

impl Add<&NeoInteger> for NeoInteger

type Output = NeoInteger

The resulting type after applying the + operator.

fn add(self, rhs: &NeoInteger) -> <NeoInteger as Add<&NeoInteger>>::Output

Performs the + operation.

impl Add<&NeoInteger> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the + operator.

fn add(self, rhs: &NeoInteger) -> <&NeoInteger as Add<&NeoInteger>>::Output

Performs the + operation.

impl Add<NeoInteger> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the + operator.

fn add(self, rhs: NeoInteger) -> <&NeoInteger as Add<NeoInteger>>::Output

Performs the + operation.

impl BitAnd for NeoInteger

type Output = NeoInteger

The resulting type after applying the & operator.

fn bitand(self, rhs: NeoInteger) -> <NeoInteger as BitAnd>::Output

Performs the & operation.

impl BitAnd<&NeoInteger> for NeoInteger

type Output = NeoInteger

The resulting type after applying the & operator.

fn bitand(self, rhs: &NeoInteger) -> <NeoInteger as BitAnd<&NeoInteger>>::Output

Performs the & operation.

impl BitAnd<&NeoInteger> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the & operator.

fn bitand( self, rhs: &NeoInteger, ) -> <&NeoInteger as BitAnd<&NeoInteger>>::Output

Performs the & operation.

impl BitAnd<NeoInteger> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the & operator.

fn bitand(self, rhs: NeoInteger) -> <&NeoInteger as BitAnd<NeoInteger>>::Output

Performs the & operation.

impl BitOr for NeoInteger

type Output = NeoInteger

The resulting type after applying the | operator.

fn bitor(self, rhs: NeoInteger) -> <NeoInteger as BitOr>::Output

Performs the | operation.

impl BitOr<&NeoInteger> for NeoInteger

type Output = NeoInteger

The resulting type after applying the | operator.

fn bitor(self, rhs: &NeoInteger) -> <NeoInteger as BitOr<&NeoInteger>>::Output

Performs the | operation.

impl BitOr<&NeoInteger> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the | operator.

fn bitor(self, rhs: &NeoInteger) -> <&NeoInteger as BitOr<&NeoInteger>>::Output

Performs the | operation.

impl BitOr<NeoInteger> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the | operator.

fn bitor(self, rhs: NeoInteger) -> <&NeoInteger as BitOr<NeoInteger>>::Output

Performs the | operation.

impl BitXor for NeoInteger

type Output = NeoInteger

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: NeoInteger) -> <NeoInteger as BitXor>::Output

Performs the ^ operation.

impl BitXor<&NeoInteger> for NeoInteger

type Output = NeoInteger

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: &NeoInteger) -> <NeoInteger as BitXor<&NeoInteger>>::Output

Performs the ^ operation.

impl BitXor<&NeoInteger> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the ^ operator.

fn bitxor( self, rhs: &NeoInteger, ) -> <&NeoInteger as BitXor<&NeoInteger>>::Output

Performs the ^ operation.

impl BitXor<NeoInteger> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: NeoInteger) -> <&NeoInteger as BitXor<NeoInteger>>::Output

Performs the ^ operation.

impl Clone for NeoInteger

fn clone(&self) -> NeoInteger

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NeoInteger

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

Formats the value using the given formatter.

impl Default for NeoInteger

fn default() -> NeoInteger

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NeoInteger

fn deserialize<__D>( __deserializer: __D, ) -> Result<NeoInteger, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for NeoInteger

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

Formats the value using the given formatter.

impl Div for NeoInteger

type Output = NeoInteger

The resulting type after applying the / operator.

fn div(self, rhs: NeoInteger) -> <NeoInteger as Div>::Output

Performs the / operation.

impl Div<&NeoInteger> for NeoInteger

type Output = NeoInteger

The resulting type after applying the / operator.

fn div(self, rhs: &NeoInteger) -> <NeoInteger as Div<&NeoInteger>>::Output

Performs the / operation.

impl Div<&NeoInteger> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the / operator.

fn div(self, rhs: &NeoInteger) -> <&NeoInteger as Div<&NeoInteger>>::Output

Performs the / operation.

impl Div<NeoInteger> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the / operator.

fn div(self, rhs: NeoInteger) -> <&NeoInteger as Div<NeoInteger>>::Output

Performs the / operation.

impl Eq for NeoInteger

impl From<&BigInt> for NeoInteger

fn from(value: &BigInt) -> NeoInteger

Converts to this type from the input type.

impl From<BigInt> for NeoInteger

fn from(value: BigInt) -> NeoInteger

Converts to this type from the input type.

impl From<NeoInteger> for NeoValue

fn from(value: NeoInteger) -> NeoValue

Converts to this type from the input type.

impl From<i8> for NeoInteger

fn from(value: i8) -> NeoInteger

Converts to this type from the input type.

impl From<i16> for NeoInteger

fn from(value: i16) -> NeoInteger

Converts to this type from the input type.

impl From<i32> for NeoInteger

fn from(value: i32) -> NeoInteger

Converts to this type from the input type.

impl From<i64> for NeoInteger

fn from(value: i64) -> NeoInteger

Converts to this type from the input type.

impl From<i128> for NeoInteger

fn from(value: i128) -> NeoInteger

Converts to this type from the input type.

impl From<u8> for NeoInteger

fn from(value: u8) -> NeoInteger

Converts to this type from the input type.

impl From<u16> for NeoInteger

fn from(value: u16) -> NeoInteger

Converts to this type from the input type.

impl From<u32> for NeoInteger

fn from(value: u32) -> NeoInteger

Converts to this type from the input type.

impl From<u64> for NeoInteger

fn from(value: u64) -> NeoInteger

Converts to this type from the input type.

impl From<u128> for NeoInteger

fn from(value: u128) -> NeoInteger

Converts to this type from the input type.

impl FromNeoValue for NeoInteger

fn from_value(value: &NeoValue) -> Result<NeoInteger, NeoError>

Convert a NeoValue into Self. Returns an error if the value’s runtime type doesn’t match Self’s expected type (e.g. trying to extract an Integer from a String).

impl Mul for NeoInteger

type Output = NeoInteger

The resulting type after applying the * operator.

fn mul(self, rhs: NeoInteger) -> <NeoInteger as Mul>::Output

Performs the * operation.

impl Mul<&NeoInteger> for NeoInteger

type Output = NeoInteger

The resulting type after applying the * operator.

fn mul(self, rhs: &NeoInteger) -> <NeoInteger as Mul<&NeoInteger>>::Output

Performs the * operation.

impl Mul<&NeoInteger> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the * operator.

fn mul(self, rhs: &NeoInteger) -> <&NeoInteger as Mul<&NeoInteger>>::Output

Performs the * operation.

impl Mul<NeoInteger> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the * operator.

fn mul(self, rhs: NeoInteger) -> <&NeoInteger as Mul<NeoInteger>>::Output

Performs the * operation.

impl Not for NeoInteger

type Output = NeoInteger

The resulting type after applying the ! operator.

fn not(self) -> <NeoInteger as Not>::Output

Performs the unary ! operation.

impl Ord for NeoInteger

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

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

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

type Output = NeoInteger

The resulting type after applying the % operator.

fn rem(self, rhs: NeoInteger) -> <NeoInteger as Rem>::Output

Performs the % operation.

impl Rem<&NeoInteger> for NeoInteger

type Output = NeoInteger

The resulting type after applying the % operator.

fn rem(self, rhs: &NeoInteger) -> <NeoInteger as Rem<&NeoInteger>>::Output

Performs the % operation.

impl Rem<&NeoInteger> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the % operator.

fn rem(self, rhs: &NeoInteger) -> <&NeoInteger as Rem<&NeoInteger>>::Output

Performs the % operation.

impl Rem<NeoInteger> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the % operator.

fn rem(self, rhs: NeoInteger) -> <&NeoInteger as Rem<NeoInteger>>::Output

Performs the % operation.

impl Serialize for NeoInteger

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Shl<u32> for NeoInteger

type Output = NeoInteger

The resulting type after applying the << operator.

fn shl(self, rhs: u32) -> <NeoInteger as Shl<u32>>::Output

Performs the << operation.

impl Shl<u32> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the << operator.

fn shl(self, rhs: u32) -> <&NeoInteger as Shl<u32>>::Output

Performs the << operation.

impl Shr<u32> for NeoInteger

type Output = NeoInteger

The resulting type after applying the >> operator.

fn shr(self, rhs: u32) -> <NeoInteger as Shr<u32>>::Output

Performs the >> operation.

impl Shr<u32> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the >> operator.

fn shr(self, rhs: u32) -> <&NeoInteger as Shr<u32>>::Output

Performs the >> operation.

impl StructuralPartialEq for NeoInteger

impl Sub for NeoInteger

type Output = NeoInteger

The resulting type after applying the - operator.

fn sub(self, rhs: NeoInteger) -> <NeoInteger as Sub>::Output

Performs the - operation.

impl Sub<&NeoInteger> for NeoInteger

type Output = NeoInteger

The resulting type after applying the - operator.

fn sub(self, rhs: &NeoInteger) -> <NeoInteger as Sub<&NeoInteger>>::Output

Performs the - operation.

impl Sub<&NeoInteger> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the - operator.

fn sub(self, rhs: &NeoInteger) -> <&NeoInteger as Sub<&NeoInteger>>::Output

Performs the - operation.

impl Sub<NeoInteger> for &NeoInteger

type Output = NeoInteger

The resulting type after applying the - operator.

fn sub(self, rhs: NeoInteger) -> <&NeoInteger as Sub<NeoInteger>>::Output

Performs the - operation.