stdint

Crates.iostdint
lib.rsstdint
version1.0.0
created_at2022-12-22 17:00:45.631896+00
updated_at2024-06-03 15:43:27.218547+00
descriptionC99 stdint/stdio types for easier interop
homepagehttps://github.com/sunsided/stdint-rs
repositoryhttps://github.com/sunsided/stdint-rs
max_upload_size
id744024
size21,528
Markus Mayer (sunsided)

documentation

README

stdint

Provides C99 integer types such as uint_fast16_t, uint_least16_t etc. for interfacing with C libraries that use them in both standard and no_std environments. Inspired by Vojtech Kral's C99 crate.

The library defaults to use the std crate. You can therefore simply add the dependency to your Cargo.toml file:

[dependencies]
stdint = "*"

To use the library in no_std environment, disable the use of default features:

[dependencies]
stdint = { version = "*", default-features = false }

Note that the specific type aliases depend on your target architecture. On docs.rs, the int_fast16_t type is currently shown as aliased to an std::ffi::c_long; this is an artifact of the documentation generator:

pub type int_fast16_t = c_long;

The actual guarantees are:

#[test]
fn int16() {
    assert_eq!(size_of::<int16_t>(), 2);
    assert!(size_of::<int_least16_t>() >= 2);
    assert!(size_of::<int_fast16_t>() >= 2);

    assert_eq!(size_of::<uint16_t>(), 2);
    assert!(size_of::<uint_least16_t>() >= 2);
    assert!(size_of::<uint_fast16_t>() >= 2);
}

To execute the tests in no_std mode, run

$ cargo test --no-default-features

Types of defined sizes

N Exact size (N bits) Smallest type with at least N bits Fastest type with at least N bits
8 int8_t, uint8_t int_least8_t, uint_least8_t int_fast8_t, uint_fast8_t
16 int16_t, uint16_t int_least16_t, uint_least16_t int_fast16_t, uint_fast16_t
32 int32_t, uint32_t int_least32_t, uint_least32_t int_fast32_t, uint_fast32_t
64 int64_t, uint64_t int_least64_t, uint_least64_t int_fast64_t, uint_fast64_t

Special types

Type Purpose
intptr_t, uintptr_t Type capable of holding *void
intmax_t, uintmax_t Largest integer type available

Constants

According MIN and MAX constants defined in stdint.h are exposed through the consts module such as INT_FAST16_MIN and INT_FAST16_MAX. Due to Rust's type system, these value are identical to int_fast16_t::MIN and int_fast16_t::MAX.

Commit count: 27

cargo fmt