Standard Library

The Pattern Language Standard Library is a set of utility functions and intrinsics to interact with ImHex or the currently loaded data.

Note

To use the Standard Library, it first needs to be installed. The easiest way to do that is through the Content Store under Help -> Content Store. Select the Libraries tab and install std from there.

Libraries

• Bit Operations 1.10.1
  • Functions
    • std::bit::popcount(u128 value) -> u128 1.10.1
    • std::bit::has_single_bit(u128 value) -> bool 1.10.1
    • std::bit::bit_ceil(u128 value) -> u128 1.10.1
    • std::bit::bit_floor(u128 value) -> u128 1.10.1
• C Types 1.10.1
  • Types
    • uint8_t 1.10.1
    • uint16_t 1.10.1
    • uint32_t 1.10.1
    • uint64_t 1.10.1
    • uint128_t 1.10.1
    • int8_t 1.10.1
    • int16_t 1.10.1
    • int32_t 1.10.1
    • int64_t 1.10.1
    • int128_t 1.10.1
    • float32_t 1.10.1
    • float64_t 1.10.1
    • size_t 1.10.1
    • ssize_t 1.10.1
• Character Type Library 1.10.1
  • Functions
    • std::ctype::isdigit(char c) -> bool 1.10.1
    • std::ctype::isxdigit(char c) -> bool 1.10.1
    • std::ctype::isupper(char c) -> bool 1.10.1
    • std::ctype::islower(char c) -> bool 1.10.1
    • std::ctype::isalpha(char c) -> bool 1.10.1
    • std::ctype::isalnum(char c) -> bool 1.10.1
    • std::ctype::isspace(char c) -> bool 1.10.1
    • std::ctype::isblank(char c) -> bool 1.10.1
    • std::ctype::isprint(char c) -> bool 1.10.1
    • std::ctype::iscntrl(char c) -> bool 1.10.1
    • std::ctype::isgraph(char c) -> bool 1.10.1
    • std::ctype::ispunct(char c) -> bool 1.10.1
• File I/O Library 1.12.0
  • Types
    • Handle
  • Functions
    • std::file::open(str path, std::file::Mode mode) -> std::file::Handle 1.12.0
    • std::file::close(std::file::Handle handle) 1.12.0
    • std::file::read(std::file::Handle handle, u128 size) -> str 1.12.0
    • std::file::write(std::file::Handle handle, str data) 1.12.0
    • std::file::seek(std::file::Handle handle, u128 offset) 1.12.0
    • std::file::size(std::file::Handle handle) -> u128 1.12.0
    • std::file::resize(std::file::Handle handle, u128 size) 1.12.0
    • std::file::flush(std::file::Handle handle) 1.12.0
    • std::file::remove(std::file::Handle handle) 1.12.0
• Fixed-point Library 1.10.1
  • Types
    • fixed
  • Functions
    • std::fxpt::to_float(fixed fxt, u32 precision) -> double 1.10.1
    • std::fxpt::to_fixed(double flt, u32 precision) -> fixed 1.10.1
    • std::fxpt::change_precision(fixed value, u32 start_precision, u32 end_precision) -> fixed 1.10.1
    • std::fxpt::add(fixed a, fixed b, u32 precision) -> fixed 1.10.1
    • std::fxpt::subtract(fixed a, fixed b, u32 precision) -> fixed 1.10.1
    • std::fxpt::multiply(fixed a, fixed b, u32 precision) -> fixed 1.10.1
    • std::fxpt::divide(fixed a, fixed b, u32 precision) -> fixed 1.10.1
• Networking Library 1.10.1
  • Functions
    • std::http::get(str url) -> str 1.10.1
• Console I/O Library
  • Functions
    • std::print(str format, auto args...)
    • std::format(str format, auto args...) -> str
• Numeric Limits Library 1.10.1
  • Functions
    • std::limits::u8_min() -> u8 1.10.1
    • std::limits::u8_max() -> u8 1.10.1
    • std::limits::u16_min() -> u16 1.10.1
    • std::limits::u16_max() -> u16 1.10.1
    • std::limits::u32_min() -> u32 1.10.1
    • std::limits::u32_max() -> u32 1.10.1
    • std::limits::u64_min() -> u64 1.10.1
    • std::limits::u64_max() -> u64 1.10.1
    • std::limits::u128_min() -> u128 1.10.1
    • std::limits::u128_max() -> u128 1.10.1
    • std::limits::s8_min() -> s8 1.10.1
    • std::limits::s8_max() -> s8 1.10.1
    • std::limits::s16_min() -> s16 1.10.1
    • std::limits::s16_max() -> s16 1.10.1
    • std::limits::s32_min() -> s32 1.10.1
    • std::limits::s32_max() -> s32 1.10.1
    • std::limits::s64_min() -> s64 1.10.1
    • std::limits::s64_max() -> s64 1.10.1
    • std::limits::s128_min() -> s128 1.10.1
    • std::limits::s128_max() -> s128 1.10.1
• Math Library 1.10.1
  • Functions
    • std::math::min(auto a, auto b) -> auto 1.10.1
    • std::math::max(auto a, auto b) -> auto 1.10.1
    • std::math::clamp(auto x, auto min, auto max) -> auto 1.10.1
    • std::math::abs(auto x) -> auto 1.10.1
    • std::math::sign(auto x) -> auto 1.10.1
    • std::math::copy_sign(auto x, auto y) -> auto 1.10.1
    • std::math::factorial(auto x) -> auto 1.10.1
    • std::math::comb(u128 n, u128 k) -> u128 1.10.1
    • std::math::perm(u128 n, u128 k) -> u128 1.10.1
    • std::math::floor(auto value) -> auto 1.14.0
    • std::math::ceil(auto value) -> auto 1.14.0
    • std::math::round(auto value) -> auto 1.14.0
    • std::math::trunc(auto value) -> auto 1.14.0
    • std::math::log10(auto value) -> auto 1.14.0
    • std::math::log2(auto value) -> auto 1.14.0
    • std::math::ln(auto value) -> auto 1.14.0
    • std::math::fmod(auto x, auto y) -> auto 1.14.0
    • std::math::pow(auto base, auto exp) -> auto 1.14.0
    • std::math::sqrt(auto value) -> auto 1.14.0
    • std::math::cbrt(auto value) -> auto 1.14.0
    • std::math::sin(auto value) -> auto 1.14.0
    • std::math::cos(auto value) -> auto 1.14.0
    • std::math::tan(auto value) -> auto 1.14.0
    • std::math::asin(auto value) -> auto 1.14.0
    • std::math::acos(auto value) -> auto 1.14.0
    • std::math::atan(auto value) -> auto 1.14.0
    • std::math::sinh(auto value) -> auto 1.14.0
    • std::math::cosh(auto value) -> auto 1.14.0
    • std::math::tanh(auto value) -> auto 1.14.0
    • std::math::asinh(auto value) -> auto 1.14.0
    • std::math::acosh(auto value) -> auto 1.14.0
    • std::math::atanh(auto value) -> auto 1.14.0
• Memory Library
  • Functions
    • std::mem::align_to(u128 alignment, u128 value) -> u128
    • std::mem::base_address() -> u128
    • std::mem::size() -> u128
    • std::mem::find_sequence(u128 occurence_index, u8 bytes...) -> u128
    • std::mem::read_unsigned(u128 address, u128 size) -> u128
    • std::mem::read_signed(u128 address, u128 size) -> s128
    • std::mem::read_string(u128 address, u128 size) -> str
    • std::mem::eof() -> bool 1.11.0
• Pointer Support Library 1.10.1
  • Functions
    • std::ptr::relative_to_pointer(u128 offset) -> u128 1.10.1
    • std::ptr::relative_to_parent(u128 offset) -> u128 1.10.1
    • std::ptr::relative_to_end(u128 offset) -> u128 1.10.1
• Rust Types 1.10.1
  • Types
    • i8 1.10.1
    • i16 1.10.1
    • i32 1.10.1
    • i64 1.10.1
    • i128 1.10.1
    • f32 1.10.1
    • f64 1.10.1
    • usize 1.10.1
    • isize 1.10.1
• String Library 1.10.1
  • Functions
    • std::string::length(str string) -> u128
    • std::string::at(str string, u128 index) -> char
    • std::string::substr(str string, u128 pos, u128 size) -> str
    • std::string::parse_int(str string, u128 base) -> s128 1.10.1
    • std::string::parse_float(str string) -> double 1.10.1
    • std::string::to_string(auto x) -> str 1.10.1
    • std::string::starts_with(str string, str part) -> bool 1.10.1
    • std::string::ends_with(str string, str part) -> bool 1.10.1
    • std::string::contains(str a, str b) -> bool 1.10.1
    • std::string::reverse(str string) -> str 1.12.0
• Language System Library 1.10.1
  • Functions
    • std::assert(bool condition, str message)
    • std::assert_warn(bool condition, str message)
    • std::env(str name) -> auto 1.12.0
    • std::sizeof_pack(auto ... pack) -> u128 1.14.0