Skip to main content

Module 0x1::u256

use 0x1::option;
use 0x1::string;
use 0x1::vector;

Function bitwise_not​

Returns the bitwise not of the value. Each bit that is 1 becomes 0. Each bit that is 0 becomes 1.

public fun bitwise_not(x: u256): u256
Click to open
Implementation
public fun bitwise_not(x: u256): u256 {
    x ^ max_value!()
}

Function max​

Return the larger of x and y

public fun max(x: u256, y: u256): u256
Click to open
Implementation
public fun max(x: u256, y: u256): u256 {
    std::macros::num_max!(x, y)
}

Function min​

Return the smaller of x and y

public fun min(x: u256, y: u256): u256
Click to open
Implementation
public fun min(x: u256, y: u256): u256 {
    std::macros::num_min!(x, y)
}

Function diff​

Return the absolute value of x - y

public fun diff(x: u256, y: u256): u256
Click to open
Implementation
public fun diff(x: u256, y: u256): u256 {
    std::macros::num_diff!(x, y)
}

Function divide_and_round_up​

Calculate x / y, but round up the result.

public fun divide_and_round_up(x: u256, y: u256): u256
Click to open
Implementation
public fun divide_and_round_up(x: u256, y: u256): u256 {
    std::macros::num_divide_and_round_up!(x, y)
}

Function pow​

Return the value of a base raised to a power

public fun pow(base: u256, exponent: u8): u256
Click to open
Implementation
public fun pow(base: u256, exponent: u8): u256 {
    std::macros::num_pow!(base, exponent)
}

Function try_as_u8​

Try to convert a u256 to a u8. Returns None if the value is too large.

public fun try_as_u8(x: u256): option::Option<u8>
Click to open
Implementation
public fun try_as_u8(x: u256): Option<u8> {
    std::macros::try_as_u8!(x)
}

Function try_as_u16​

Try to convert a u256 to a u16. Returns None if the value is too large.

public fun try_as_u16(x: u256): option::Option<u16>
Click to open
Implementation
public fun try_as_u16(x: u256): Option<u16> {
    std::macros::try_as_u16!(x)
}

Function try_as_u32​

Try to convert a u256 to a u32. Returns None if the value is too large.

public fun try_as_u32(x: u256): option::Option<u32>
Click to open
Implementation
public fun try_as_u32(x: u256): Option<u32> {
    std::macros::try_as_u32!(x)
}

Function try_as_u64​

Try to convert a u256 to a u64. Returns None if the value is too large.

public fun try_as_u64(x: u256): option::Option<u64>
Click to open
Implementation
public fun try_as_u64(x: u256): Option<u64> {
    std::macros::try_as_u64!(x)
}

Function try_as_u128​

Try to convert a u256 to a u128. Returns None if the value is too large.

public fun try_as_u128(x: u256): option::Option<u128>
Click to open
Implementation
public fun try_as_u128(x: u256): Option<u128> {
    std::macros::try_as_u128!(x)
}

Function to_string​

public fun to_string(x: u256): string::String
Click to open
Implementation
public fun to_string(x: u256): String {
    std::macros::num_to_string!(x)
}