1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
//! Root module for 256-bit unsigned integer type.
mod api;
mod cmp;
mod convert;
mod fmt;
mod iter;
mod ops;
mod parse;
pub use self::convert::AsU256;
use crate::I256;
use core::num::ParseIntError;
/// A 256-bit unsigned integer type.
#[derive(Clone, Copy, Default, Eq, Hash, PartialEq)]
#[repr(transparent)]
pub struct U256(pub [u128; 2]);
impl U256 {
/// The additive identity for this integer type, i.e. `0`.
pub const ZERO: Self = U256([0; 2]);
/// The multiplicative identity for this integer type, i.e. `1`.
pub const ONE: Self = U256::new(1);
/// Creates a new 256-bit integer value from a primitive `u128` integer.
#[inline]
pub const fn new(value: u128) -> Self {
U256::from_words(0, value)
}
/// Creates a new 256-bit integer value from high and low words.
#[inline]
pub const fn from_words(hi: u128, lo: u128) -> Self {
#[cfg(target_endian = "little")]
{
U256([lo, hi])
}
#[cfg(target_endian = "big")]
{
U256([hi, lo])
}
}
/// Splits a 256-bit integer into high and low words.
#[inline]
pub const fn into_words(self) -> (u128, u128) {
#[cfg(target_endian = "little")]
{
let U256([lo, hi]) = self;
(hi, lo)
}
#[cfg(target_endian = "big")]
{
let U256([hi, lo]) = self;
(hi, lo)
}
}
/// Get the low 128-bit word for this unsigned integer.
#[inline]
pub fn low(&self) -> &u128 {
#[cfg(target_endian = "little")]
{
&self.0[0]
}
#[cfg(target_endian = "big")]
{
&self.0[1]
}
}
/// Get the low 128-bit word for this unsigned integer as a mutable
/// reference.
#[inline]
pub fn low_mut(&mut self) -> &mut u128 {
#[cfg(target_endian = "little")]
{
&mut self.0[0]
}
#[cfg(target_endian = "big")]
{
&mut self.0[1]
}
}
/// Get the high 128-bit word for this unsigned integer.
#[inline]
pub fn high(&self) -> &u128 {
#[cfg(target_endian = "little")]
{
&self.0[1]
}
#[cfg(target_endian = "big")]
{
&self.0[0]
}
}
/// Get the high 128-bit word for this unsigned integer as a mutable
/// reference.
#[inline]
pub fn high_mut(&mut self) -> &mut u128 {
#[cfg(target_endian = "little")]
{
&mut self.0[1]
}
#[cfg(target_endian = "big")]
{
&mut self.0[0]
}
}
/// Converts a prefixed string slice in base 16 to an integer.
///
/// The string is expected to be an optional `+` sign followed by the `0x`
/// prefix and finally the digits. Leading and trailing whitespace represent
/// an error.
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// # use ethnum::U256;
/// assert_eq!(U256::from_str_hex("0x2A"), Ok(U256::new(42)));
/// ```
pub fn from_str_hex(src: &str) -> Result<Self, ParseIntError> {
crate::parse::from_str_radix(src, 16, Some("0x"))
}
/// Converts a prefixed string slice in a base determined by the prefix to
/// an integer.
///
/// The string is expected to be an optional `+` sign followed by the one of
/// the supported prefixes and finally the digits. Leading and trailing
/// whitespace represent an error. The base is determined based on the
/// prefix:
///
/// * `0b`: base `2`
/// * `0o`: base `8`
/// * `0x`: base `16`
/// * no prefix: base `10`
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// # use ethnum::U256;
/// assert_eq!(U256::from_str_prefixed("0b101"), Ok(U256::new(0b101)));
/// assert_eq!(U256::from_str_prefixed("0o17"), Ok(U256::new(0o17)));
/// assert_eq!(U256::from_str_prefixed("0xa"), Ok(U256::new(0xa)));
/// assert_eq!(U256::from_str_prefixed("42"), Ok(U256::new(42)));
/// ```
pub fn from_str_prefixed(src: &str) -> Result<Self, ParseIntError> {
crate::parse::from_str_prefixed(src)
}
/// Same as [`U256::from_str_prefixed`] but as a `const fn`. This method is
/// not intended to be used directly but rather through the [`crate::uint`]
/// macro.
#[doc(hidden)]
pub const fn const_from_str_prefixed(src: &str) -> Self {
parse::const_from_str_prefixed(src)
}
/// Cast to a primitive `i8`.
#[inline]
pub const fn as_i8(self) -> i8 {
let (_, lo) = self.into_words();
lo as _
}
/// Cast to a primitive `i16`.
#[inline]
pub const fn as_i16(self) -> i16 {
let (_, lo) = self.into_words();
lo as _
}
/// Cast to a primitive `i32`.
#[inline]
pub const fn as_i32(self) -> i32 {
let (_, lo) = self.into_words();
lo as _
}
/// Cast to a primitive `i64`.
#[inline]
pub const fn as_i64(self) -> i64 {
let (_, lo) = self.into_words();
lo as _
}
/// Cast to a primitive `i128`.
#[inline]
pub const fn as_i128(self) -> i128 {
let (_, lo) = self.into_words();
lo as _
}
/// Cast to a `I256`.
#[inline]
pub const fn as_i256(self) -> I256 {
let Self([a, b]) = self;
I256([a as _, b as _])
}
/// Cast to a primitive `u8`.
#[inline]
pub const fn as_u8(self) -> u8 {
let (_, lo) = self.into_words();
lo as _
}
/// Cast to a primitive `u16`.
#[inline]
pub const fn as_u16(self) -> u16 {
let (_, lo) = self.into_words();
lo as _
}
/// Cast to a primitive `u32`.
#[inline]
pub const fn as_u32(self) -> u32 {
let (_, lo) = self.into_words();
lo as _
}
/// Cast to a primitive `u64`.
#[inline]
pub const fn as_u64(self) -> u64 {
let (_, lo) = self.into_words();
lo as _
}
/// Cast to a primitive `u128`.
#[inline]
pub const fn as_u128(self) -> u128 {
let (_, lo) = self.into_words();
lo
}
/// Cast to a primitive `isize`.
#[inline]
pub const fn as_isize(self) -> isize {
let (_, lo) = self.into_words();
lo as _
}
/// Cast to a primitive `usize`.
#[inline]
pub const fn as_usize(self) -> usize {
let (_, lo) = self.into_words();
lo as _
}
/// Cast to a primitive `f32`.
#[inline]
pub fn as_f32(self) -> f32 {
match self.into_words() {
(0, lo) => lo as _,
_ => f32::INFINITY,
}
}
/// Cast to a primitive `f64`.
#[inline]
pub fn as_f64(self) -> f64 {
// NOTE: Binary representation of 2**128. This is used because `powi` is
// neither `const` nor `no_std`.
const HI: u64 = 0x47f0000000000000;
let (hi, lo) = self.into_words();
(hi as f64) * f64::from_bits(HI) + (lo as f64)
}
}
#[cfg(test)]
mod tests {
use crate::uint::U256;
#[test]
#[allow(clippy::float_cmp)]
fn converts_to_f64() {
assert_eq!(U256::from_words(1, 0).as_f64(), 2.0f64.powi(128))
}
}