forge::revm::interpreter::primitives::alloy_primitives

Struct Signed

pub struct Signed<const BITS: usize, const LIMBS: usize>(pub(crate) Uint<BITS, LIMBS>);

Expand description

Signed integer wrapping a ruint::Uint.

This signed integer implementation is fully abstract across the number of bits. It wraps a ruint::Uint, and co-opts the most significant bit to represent the sign. The number is represented in two’s complement, using the underlying Uint’s u64 limbs. The limbs can be accessed via the Signed::as_limbs() method, and are least-significant first.

§Aliases

We provide aliases for every bit-width divisble by 8, from 8 to 256. These are located in crate::aliases and are named I256, I248 etc. Most users will want crate::I256.

§Usage

// Instantiate from a number
let a = I256::unchecked_from(1);
// Use `try_from` if you're not sure it'll fit
let b = I256::try_from(200000382).unwrap();

// Or parse from a string :)
let c = "100".parse::<I256>().unwrap();
let d = "-0x138f".parse::<I256>().unwrap();

// Preceding plus is allowed but not recommended
let e = "+0xdeadbeef".parse::<I256>().unwrap();

// Underscores are ignored
let f = "1_000_000".parse::<I256>().unwrap();

// But invalid chars are not
assert!("^31".parse::<I256>().is_err());

// Math works great :)
let g = a * b + c - d;

// And so do comparisons!
assert!(e > a);

// We have some useful constants too
assert_eq!(I256::ZERO, I256::unchecked_from(0));
assert_eq!(I256::ONE, I256::unchecked_from(1));
assert_eq!(I256::MINUS_ONE, I256::unchecked_from(-1));

Tuple Fields§

§0: Uint<BITS, LIMBS>

Implementations§

§

Returns the number of zeros in the binary representation of self.

pub fn leading_zeros(&self) -> usize

Returns the number of leading zeros in the binary representation of self.

pub fn trailing_zeros(&self) -> usize

Returns the number of leading zeros in the binary representation of self.

pub fn trailing_ones(&self) -> usize

Returns the number of leading ones in the binary representation of self.

pub const fn bit(&self, index: usize) -> bool

pub const fn from_be_bytes<const BYTES: usize>( bytes: [u8; BYTES], ) -> Signed<BITS, LIMBS>

Converts a big-endian byte array of size exactly Self::BYTES.

§Panics

Panics if the generic parameter BYTES is not exactly Self::BYTES. Ideally this would be a compile time error, but this is blocked by Rust issue #60551.

Panics if the value is too large for the bit-size of the Uint.

pub const fn from_le_bytes<const BYTES: usize>( bytes: [u8; BYTES], ) -> Signed<BITS, LIMBS>

Convert from an array in LE format

§Panics

Panics if the given array is not the correct length.

pub fn try_from_be_slice(slice: &[u8]) -> Option<Signed<BITS, LIMBS>>

Creates a new integer from a big endian slice of bytes.

The slice is interpreted as a big endian number. Leading zeros are ignored. The slice can be any length.

Returns None if the value is larger than fits the Uint.

pub fn try_from_le_slice(slice: &[u8]) -> Option<Signed<BITS, LIMBS>>

Creates a new integer from a little endian slice of bytes.

The slice is interpreted as a big endian number. Leading zeros are ignored. The slice can be any length.

Returns None if the value is larger than fits the Uint.

pub const fn as_limbs(&self) -> &[u64; LIMBS]

View the array of limbs.

pub const fn into_limbs(self) -> [u64; LIMBS]

Convert to a array of limbs.

Limbs are least significant first.

pub const fn from_limbs(limbs: [u64; LIMBS]) -> Signed<BITS, LIMBS>

Construct a new integer from little-endian a array of limbs.

§Panics

Panics if LIMBS is not equal to nlimbs(BITS).

Panics if the value is to large for the bit-size of the Uint.

pub fn from_base_be( base: u64, digits: I, ) -> Result<Signed<BITS, LIMBS>, BaseConvertError>
where I: IntoIterator<Item = u64>,

Constructs the Signed from digits in the base base in big-endian. Wrapper around ruint’s from_base_be

§Errors

BaseConvertError::InvalidBase if the base is less than 2.
BaseConvertError::InvalidDigit if a digit is out of range.
BaseConvertError::Overflow if the number is too large to fit.

§

impl<const BITS: usize, const LIMBS: usize> Signed<BITS, LIMBS>

pub fn abs(self) -> Signed<BITS, LIMBS>

Computes the absolute value of self.

§Overflow behavior

The absolute value of Self::MIN cannot be represented as Self and attempting to calculate it will cause an overflow. This means that code in debug mode will trigger a panic on this case and optimized code will return Self::MIN without a panic.

pub fn overflowing_abs(self) -> (Signed<BITS, LIMBS>, bool)

Computes the absolute value of self.

Returns a tuple of the absolute version of self along with a boolean indicating whether an overflow happened. If self is the minimum value then the minimum value will be returned again and true will be returned for an overflow happening.

pub fn checked_abs(self) -> Option<Signed<BITS, LIMBS>>

Checked absolute value. Computes self.abs(), returning None if self == MIN.

pub fn saturating_abs(self) -> Signed<BITS, LIMBS>

Saturating absolute value. Computes self.abs(), returning MAX if self == MIN instead of overflowing.

pub fn wrapping_abs(self) -> Signed<BITS, LIMBS>

Wrapping absolute value. Computes self.abs(), wrapping around at the boundary of the type.

pub fn unsigned_abs(self) -> Uint<BITS, LIMBS>

Computes the absolute value of self without any wrapping or panicking.

pub fn overflowing_neg(self) -> (Signed<BITS, LIMBS>, bool)

Negates self, overflowing if this is equal to the minimum value.

Returns a tuple of the negated version of self along with a boolean indicating whether an overflow happened. If self is the minimum value, then the minimum value will be returned again and true will be returned for an overflow happening.

pub fn checked_neg(self) -> Option<Signed<BITS, LIMBS>>

Checked negation. Computes -self, returning None if self == MIN.

pub fn saturating_neg(self) -> Signed<BITS, LIMBS>

Saturating negation. Computes -self, returning MAX if self == MIN instead of overflowing.

pub fn wrapping_neg(self) -> Signed<BITS, LIMBS>

Wrapping (modular) negation. Computes -self, wrapping around at the boundary of the type.

The only case where such wrapping can occur is when one negates MIN on a signed type (where MIN is the negative minimal value for the type); this is a positive value that is too large to represent in the type. In such a case, this function returns MIN itself.

pub const fn overflowing_add( self, rhs: Signed<BITS, LIMBS>, ) -> (Signed<BITS, LIMBS>, bool)

Calculates self + rhs

Returns a tuple of the addition along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

pub const fn checked_add( self, rhs: Signed<BITS, LIMBS>, ) -> Option<Signed<BITS, LIMBS>>

Checked integer addition. Computes self + rhs, returning None if overflow occurred.

pub const fn saturating_add( self, rhs: Signed<BITS, LIMBS>, ) -> Signed<BITS, LIMBS>

Saturating integer addition. Computes self + rhs, saturating at the numeric bounds instead of overflowing.

pub const fn wrapping_add(self, rhs: Signed<BITS, LIMBS>) -> Signed<BITS, LIMBS>

Wrapping (modular) addition. Computes self + rhs, wrapping around at the boundary of the type.

pub const fn overflowing_sub( self, rhs: Signed<BITS, LIMBS>, ) -> (Signed<BITS, LIMBS>, bool)

Calculates self - rhs

Returns a tuple of the subtraction along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

pub const fn checked_sub( self, rhs: Signed<BITS, LIMBS>, ) -> Option<Signed<BITS, LIMBS>>

Checked integer subtraction. Computes self - rhs, returning None if overflow occurred.

pub const fn saturating_sub( self, rhs: Signed<BITS, LIMBS>, ) -> Signed<BITS, LIMBS>

Saturating integer subtraction. Computes self - rhs, saturating at the numeric bounds instead of overflowing.

pub const fn wrapping_sub(self, rhs: Signed<BITS, LIMBS>) -> Signed<BITS, LIMBS>

Wrapping (modular) subtraction. Computes self - rhs, wrapping around at the boundary of the type.

pub fn overflowing_mul( self, rhs: Signed<BITS, LIMBS>, ) -> (Signed<BITS, LIMBS>, bool)

Calculates self * rhs

Returns a tuple of the multiplication along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would have occurred then the wrapped value is returned.

pub fn checked_mul( self, rhs: Signed<BITS, LIMBS>, ) -> Option<Signed<BITS, LIMBS>>

Checked integer multiplication. Computes self * rhs, returning None if overflow occurred.

pub fn saturating_mul(self, rhs: Signed<BITS, LIMBS>) -> Signed<BITS, LIMBS>

Saturating integer multiplication. Computes self * rhs, saturating at the numeric bounds instead of overflowing.

pub fn wrapping_mul(self, rhs: Signed<BITS, LIMBS>) -> Signed<BITS, LIMBS>

Wrapping (modular) multiplication. Computes self * rhs, wrapping around at the boundary of the type.

pub fn overflowing_div( self, rhs: Signed<BITS, LIMBS>, ) -> (Signed<BITS, LIMBS>, bool)

Calculates self / rhs

Returns a tuple of the divisor along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would occur then self is returned.

§Panics

If rhs is 0.

pub fn checked_div( self, rhs: Signed<BITS, LIMBS>, ) -> Option<Signed<BITS, LIMBS>>

Checked integer division. Computes self / rhs, returning None if rhs == 0 or the division results in overflow.

Checked integer remainder. Computes self % rhs, returning None if rhs == 0 or the division results in overflow.

pub fn wrapping_rem(self, rhs: Signed<BITS, LIMBS>) -> Signed<BITS, LIMBS>

Wrapping (modular) remainder. Computes self % rhs, wrapping around at the boundary of the type.

Such wrap-around never actually occurs mathematically; implementation artifacts make x % y invalid for MIN / -1 on a signed type (where MIN is the negative minimal value). In such a case, this function returns 0.

§Panics

If rhs is 0.

pub fn div_euclid(self, rhs: Signed<BITS, LIMBS>) -> Signed<BITS, LIMBS>

Calculates the quotient of Euclidean division of self by rhs.

This computes the integer q such that self = q * rhs + r, with r = self.rem_euclid(rhs) and 0 <= r < abs(rhs).

In other words, the result is self / rhs rounded to the integer q such that self >= q * rhs. If self > 0, this is equal to round towards zero (the default in Rust); if self < 0, this is equal to round towards +/- infinity.

§Panics

If rhs is 0 or the division results in overflow.

pub fn overflowing_div_euclid( self, rhs: Signed<BITS, LIMBS>, ) -> (Signed<BITS, LIMBS>, bool)

Calculates the quotient of Euclidean division self.div_euclid(rhs).

Returns a tuple of the divisor along with a boolean indicating whether an arithmetic overflow would occur. If an overflow would occur then self is returned.

Checked Euclidean remainder. Computes self.rem_euclid(rhs), returning None if rhs == 0 or the division results in overflow.

pub fn exp10(n: usize) -> Signed<BITS, LIMBS>

Create 10**n as this type.

§Panics

If the result overflows the type.

pub fn pow(self, exp: Uint<BITS, LIMBS>) -> Signed<BITS, LIMBS>

Raises self to the power of exp, using exponentiation by squaring.

§Panics

If the result overflows the type in debug mode.

pub fn overflowing_pow( self, exp: Uint<BITS, LIMBS>, ) -> (Signed<BITS, LIMBS>, bool)

Raises self to the power of exp, using exponentiation by squaring.

Returns a tuple of the exponentiation along with a bool indicating whether an overflow happened.

pub fn checked_pow(self, exp: Uint<BITS, LIMBS>) -> Option<Signed<BITS, LIMBS>>

Checked exponentiation. Computes self.pow(exp), returning None if overflow occurred.

pub fn saturating_pow(self, exp: Uint<BITS, LIMBS>) -> Signed<BITS, LIMBS>

Saturating integer exponentiation. Computes self.pow(exp), saturating at the numeric bounds instead of overflowing.

pub fn wrapping_pow(self, exp: Uint<BITS, LIMBS>) -> Signed<BITS, LIMBS>

Raises self to the power of exp, wrapping around at the boundary of the type.

pub fn overflowing_shl(self, rhs: usize) -> (Signed<BITS, LIMBS>, bool)

Generate an arbitrary value of Self from the entirety of the given unstructured data. Read more

§

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself. Read more

§

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself. Read more

§

impl<const BITS: usize, const LIMBS: usize> Arbitrary for Signed<BITS, LIMBS>

§

type Parameters = <Uint<BITS, LIMBS> as Arbitrary>::Parameters

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

§

type Strategy = Map<<Uint<BITS, LIMBS> as Arbitrary>::Strategy, fn(_: Uint<BITS, LIMBS>) -> Signed<BITS, LIMBS>>

The type of Strategy used to generate values of type Self.

§

fn arbitrary_with( _top: <Signed<BITS, LIMBS> as Arbitrary>::Parameters, ) -> <Signed<BITS, LIMBS> as Arbitrary>::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args. Read more

impl<const BITS: usize, const LIMBS: usize> BitOrAssign for Signed<BITS, LIMBS>

§

fn bitor_assign(&mut self, rhs: Signed<BITS, LIMBS>)

Performs the |= operation. Read more

§

impl<const BITS: usize, const LIMBS: usize> BitXor for Signed<BITS, LIMBS>

§

type Output = Signed<BITS, LIMBS>

The resulting type after applying the ^ operator.

fn from_str( s: &str, ) -> Result<Signed<BITS, LIMBS>, <Signed<BITS, LIMBS> as FromStr>::Err>

Parses a string s to return a value of this type. Read more

§

impl<const BITS: usize, const LIMBS: usize> Hash for Signed<BITS, LIMBS>

§

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

Feeds this value into the given Hasher. Read more

impl<const BITS: usize, const LIMBS: usize> Not for Signed<BITS, LIMBS>

§

type Output = Signed<BITS, LIMBS>

The resulting type after applying the ! operator.

Compares and returns the maximum of two values. Read more

1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more

1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more

§

impl<const BITS: usize, const LIMBS: usize> PartialEq for Signed<BITS, LIMBS>

§

fn eq(&self, other: &Signed<BITS, LIMBS>) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

§

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<112, 2>

§

type SolType = Int<112>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<120, 2>

§

type SolType = Int<120>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<136, 3>

§

type SolType = Int<136>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<144, 3>

§

type SolType = Int<144>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<152, 3>

§

type SolType = Int<152>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<160, 3>

§

type SolType = Int<160>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<168, 3>

§

type SolType = Int<168>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<176, 3>

§

type SolType = Int<176>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<184, 3>

§

type SolType = Int<184>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<192, 3>

§

type SolType = Int<192>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<200, 4>

§

type SolType = Int<200>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<208, 4>

§

type SolType = Int<208>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<216, 4>

§

type SolType = Int<216>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<224, 4>

§

type SolType = Int<224>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<232, 4>

§

type SolType = Int<232>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<24, 1>

§

type SolType = Int<24>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<240, 4>

§

type SolType = Int<240>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<248, 4>

§

type SolType = Int<248>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<256, 4>

§

type SolType = Int<256>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<40, 1>

§

type SolType = Int<40>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<48, 1>

§

type SolType = Int<48>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<56, 1>

§

type SolType = Int<56>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<72, 2>

§

type SolType = Int<72>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<80, 2>

§

type SolType = Int<80>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<88, 2>

§

type SolType = Int<88>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl SolValue for Signed<96, 2>

§

type SolType = Int<96>

The Solidity type that this type corresponds to.

§

fn sol_name(&self) -> &'static str

The name of the associated Solidity type. Read more

§

fn sol_type_name(&self) -> Cow<'static, str>

👎Deprecated since 0.6.3: use sol_name instead

ABI-decode this type from the given data. Read more

§

impl<T, const BITS: usize, const LIMBS: usize> Sub<T> for Signed<BITS, LIMBS>
where T: Into<Signed<BITS, LIMBS>>,

§

type Output = Signed<BITS, LIMBS>

The resulting type after applying the - operator.

§

fn sub(self, rhs: T) -> <Signed<BITS, LIMBS> as Sub<T>>::Output

Performs the - operation. Read more

§

impl<T, const BITS: usize, const LIMBS: usize> SubAssign<T> for Signed<BITS, LIMBS>
where T: Into<Signed<BITS, LIMBS>>,

§

fn sub_assign(&mut self, rhs: T)

Performs the -= operation. Read more

§

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();

§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Primary].

§Example

println!("{}", value.primary());

§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color::Fixed].

§Example

println!("{}", value.fixed(color));

§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color::Rgb].

§Example

println!("{}", value.rgb(r, g, b));

§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Black].

§Example

println!("{}", value.black());

§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Red].

§Example

println!("{}", value.red());

§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Green].

§Example

println!("{}", value.green());

§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Yellow].

§Example

println!("{}", value.yellow());

§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Blue].

§Example

println!("{}", value.blue());

§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Magenta].

§Example

println!("{}", value.magenta());

§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color::Cyan].

§Example

println!("{}", value.cyan());

§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color::White].

§Example

println!("{}", value.white());

§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightBlack].

§Example

println!("{}", value.bright_black());

§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightRed].

§Example

println!("{}", value.bright_red());

§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightGreen].

§Example

println!("{}", value.bright_green());

§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightYellow].

§Example

println!("{}", value.bright_yellow());

§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightBlue].

§Example

println!("{}", value.bright_blue());

§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightMagenta].

§Example

println!("{}", value.bright_magenta());

§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightCyan].

§Example

println!("{}", value.bright_cyan());

§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color::BrightWhite].

§Example

println!("{}", value.bright_white());

§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();

§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Primary].

§Example

println!("{}", value.on_primary());

§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color::Fixed].

§Example

println!("{}", value.on_fixed(color));

§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color::Rgb].

§Example

println!("{}", value.on_rgb(r, g, b));

§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Black].

§Example

println!("{}", value.on_black());

§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Red].

§Example

println!("{}", value.on_red());

§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Green].

§Example

println!("{}", value.on_green());

§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Yellow].

§Example

println!("{}", value.on_yellow());

§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Blue].

§Example

println!("{}", value.on_blue());

§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Magenta].

§Example

println!("{}", value.on_magenta());

§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color::Cyan].

§Example

println!("{}", value.on_cyan());

§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color::White].

§Example

println!("{}", value.on_white());

§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightBlack].

§Example

println!("{}", value.on_bright_black());

§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightRed].

§Example

println!("{}", value.on_bright_red());

§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightGreen].

§Example

println!("{}", value.on_bright_green());

§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightYellow].

§Example

println!("{}", value.on_bright_yellow());

§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightBlue].

§Example

println!("{}", value.on_bright_blue());

§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightMagenta].

§Example

println!("{}", value.on_bright_magenta());

§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightCyan].

§Example

println!("{}", value.on_bright_cyan());

§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color::BrightWhite].

§Example

println!("{}", value.on_bright_white());

§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling [Attribute] value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();

§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Bold].

§Example

println!("{}", value.bold());

§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Dim].

§Example

println!("{}", value.dim());

§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Italic].

§Example

println!("{}", value.italic());

§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Underline].

§Example

println!("{}", value.underline());

§

fn blink(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Blink].

§Example

println!("{}", value.blink());

§

fn rapid_blink(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::RapidBlink].

§Example

println!("{}", value.rapid_blink());

§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Invert].

§Example

println!("{}", value.invert());

§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Conceal].

§Example

println!("{}", value.conceal());

§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute::Strike].

§Example

println!("{}", value.strike());

§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi [Quirk] value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();

§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::Mask].

§Example

println!("{}", value.mask());

§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::Wrap].

§Example

println!("{}", value.wrap());

§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::Linger].

§Example

println!("{}", value.linger());

§

fn clear(&self) -> Painted<&T>

👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to [Quirk::Clear].

§Example

println!("{}", value.clear());

§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::Resetting].

§Example

println!("{}", value.resetting());

§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::Bright].

§Example

println!("{}", value.bright());

§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk::OnBright].

§Example

println!("{}", value.on_bright());

§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the [Condition] value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);

§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new [Painted] with a default [Style]. Read more

§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more

§

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.

Source §

impl<T> ToOwned for T
where T: Clone,

Source §

type Owned = T

The resulting type after obtaining ownership.

Source §

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more

Layout§

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.

Struct SignedCopy item path

§Aliases

§Usage

Tuple Fields§

Implementations§

impl<const BITS: usize, const LIMBS: usize> Signed<BITS, LIMBS>

pub const fn low_u8(&self) -> u8

pub fn as_u8(&self) -> u8

§Panics

pub const fn low_i8(&self) -> i8

pub fn as_i8(&self) -> i8

§Panics

pub const fn low_u16(&self) -> u16

pub fn as_u16(&self) -> u16

§Panics

pub const fn low_i16(&self) -> i16

pub fn as_i16(&self) -> i16

§Panics

pub const fn low_u32(&self) -> u32

pub fn as_u32(&self) -> u32

§Panics

pub const fn low_i32(&self) -> i32

pub fn as_i32(&self) -> i32

§Panics

pub const fn low_u64(&self) -> u64

pub fn as_u64(&self) -> u64

§Panics

pub const fn low_i64(&self) -> i64

pub fn as_i64(&self) -> i64

§Panics

pub const fn low_usize(&self) -> usize

pub fn as_usize(&self) -> usize

§Panics

pub const fn low_isize(&self) -> isize

pub fn as_isize(&self) -> isize

§Panics

impl<const BITS: usize, const LIMBS: usize> Signed<BITS, LIMBS>

pub const BITS: usize = BITS

pub const BYTES: usize = Uint<BITS, LIMBS>::BYTES

pub const MIN: Signed<BITS, LIMBS>

pub const MAX: Signed<BITS, LIMBS>

pub const ZERO: Signed<BITS, LIMBS>

pub const ONE: Signed<BITS, LIMBS>

pub const MINUS_ONE: Signed<BITS, LIMBS>

pub const fn from_raw(val: Uint<BITS, LIMBS>) -> Signed<BITS, LIMBS>

pub fn unchecked_from<T>(val: T) -> Signed<BITS, LIMBS>where T: TryInto<Signed<BITS, LIMBS>>, <T as TryInto<Signed<BITS, LIMBS>>>::Error: Debug,

§Panics

pub fn unchecked_into<T>(self) -> Twhere Signed<BITS, LIMBS>: TryInto<T>, <Signed<BITS, LIMBS> as TryInto<T>>::Error: Debug,

§Panics

pub const fn into_raw(self) -> Uint<BITS, LIMBS>

pub const fn sign(&self) -> Sign

pub const fn is_odd(&self) -> bool

pub const fn const_eq(&self, other: &Signed<BITS, LIMBS>) -> bool

pub const fn is_zero(&self) -> bool

pub const fn is_positive(&self) -> bool

pub const fn is_negative(&self) -> bool

pub fn count_ones(&self) -> usize

pub fn count_zeros(&self) -> usize

pub fn leading_zeros(&self) -> usize

pub fn trailing_zeros(&self) -> usize

pub fn trailing_ones(&self) -> usize

pub const fn bit(&self, index: usize) -> bool

pub const fn byte(&self, index: usize) -> u8

§Panics

pub fn bits(&self) -> u32

pub fn overflowing_from_sign_and_abs( sign: Sign, abs: Uint<BITS, LIMBS>, ) -> (Signed<BITS, LIMBS>, bool)

pub fn checked_from_sign_and_abs( sign: Sign, abs: Uint<BITS, LIMBS>, ) -> Option<Signed<BITS, LIMBS>>

pub fn from_dec_str( value: &str, ) -> Result<Signed<BITS, LIMBS>, ParseSignedError>

pub fn to_dec_string(&self) -> String

pub fn from_hex_str( value: &str, ) -> Result<Signed<BITS, LIMBS>, ParseSignedError>

pub fn to_hex_string(&self) -> String

pub fn into_sign_and_abs(&self) -> (Sign, Uint<BITS, LIMBS>)

pub const fn to_be_bytes<const BYTES: usize>(&self) -> [u8; BYTES]

§Panics

pub const fn to_le_bytes<const BYTES: usize>(&self) -> [u8; BYTES]

§Panics

pub const fn from_be_bytes<const BYTES: usize>( bytes: [u8; BYTES], ) -> Signed<BITS, LIMBS>

§Panics

pub const fn from_le_bytes<const BYTES: usize>( bytes: [u8; BYTES], ) -> Signed<BITS, LIMBS>

§Panics

Struct Signed

pub fn unchecked_from<T>(val: T) -> Signed<BITS, LIMBS>
where T: TryInto<Signed<BITS, LIMBS>>, <T as TryInto<Signed<BITS, LIMBS>>>::Error: Debug,

pub fn unchecked_into<T>(self) -> T
where Signed<BITS, LIMBS>: TryInto<T>, <Signed<BITS, LIMBS> as TryInto<T>>::Error: Debug,

pub fn from_base_be<I>( base: u64, digits: I, ) -> Result<Signed<BITS, LIMBS>, BaseConvertError>
where I: IntoIterator<Item = u64>,