[go: up one dir, main page]

Crate bitfrob

source ·
Expand description

A crate to help with bit manipulation of integers.

Naming Conventions

  • The bit function work on a single bit.
  • The region functions work on multiple adjacent bits.
  • The value functions are like a region but the value is automatically shifted down on read and up on write so that you can input/output normal values and the function will put it in place for you.
  • get reads a value.
  • with returns a new value.

Features

  • track_caller adds the #[track_caller] attribute on all the functions that assert stuff. Note that using the track_caller attribute can give LLVM trouble with inlining, so it’s suggested that you only use this feature as necessary during debugging.

Structs

  • U8BitIterHigh
    Iterator for groups of bits in an integer (low to high).
  • U8BitIterLow
    Iterator for groups of bits in an integer (low to high).
  • U16BitIterHigh
    Iterator for groups of bits in an integer (low to high).
  • U16BitIterLow
    Iterator for groups of bits in an integer (low to high).
  • U32BitIterHigh
    Iterator for groups of bits in an integer (low to high).
  • U32BitIterLow
    Iterator for groups of bits in an integer (low to high).
  • U64BitIterHigh
    Iterator for groups of bits in an integer (low to high).
  • U64BitIterLow
    Iterator for groups of bits in an integer (low to high).
  • U128BitIterHigh
    Iterator for groups of bits in an integer (low to high).
  • U128BitIterLow
    Iterator for groups of bits in an integer (low to high).
  • u8x2
    Two u8 values packed as a u16.

Functions