Struct fixed_bitmaps::Bitmap8 [−][src]
pub struct Bitmap8(_);
Expand description
The smallest denomination of bitmap in this crate. This is simply a byte-long bitmap, useful for when only a few flags would be defined.
Examples
use fixed_bitmaps::Bitmap8;
// Creates an empty bitmap
let mut bitmap = Bitmap8::default();
// Bitmaps implement Display so you can view what the map looks like
// Will show 00000000
println!("Default bitmap: {}", bitmap);
// Bitmaps also convert to their respective unsigned int versions and back again easily
// Will show 0 as the value of the bitmap
println!("Value of bitmap: {}", bitmap.to_u8());
// Let's do the same as above, but actually setting the values in the bitmap to something
bitmap |= Bitmap8::from(101);
// Will show 01100101
println!("Bitmap after OR-ing with 101: {}", bitmap);
// Set the 4th index (the 5th bit) to true. Can simply unwrap the result to ignore the warning,
//as we know for certain that 4 < 8
bitmap.set(4, true).unwrap();
// Will show that 117 (101 + 2^4) is the value of the bitmap
println!("Bitmap value: {}", bitmap.to_u8());
Implementations
Creates a new, empty Bitmap8
, and sets the desired index before returning. The least significant bit is at index 0.
Example
use fixed_bitmaps::Bitmap8;
let a = Bitmap8::from_set(2).unwrap();
// The above is equivalent to:
let b = Bitmap8::from(0b100);
assert!(a == b);
Trait Implementations
Performs the +=
operation. Read more
Performs the +=
operation. Read more
Performs the &=
operation. Read more
Performs the &=
operation. Read more
Performs the |=
operation. Read more
Performs the |=
operation. Read more
Performs the ^=
operation. Read more
Performs the ^=
operation. Read more
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
Performs the /=
operation. Read more
Performs the /=
operation. Read more
Performs the *=
operation. Read more
Performs the *=
operation. Read more
This method returns an ordering between self
and other
values if one exists. Read more
This method tests less than (for self
and other
) and is used by the <
operator. Read more
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
Performs the -=
operation. Read more
Performs the -=
operation. Read more
Auto Trait Implementations
impl RefUnwindSafe for Bitmap8
impl UnwindSafe for Bitmap8
Blanket Implementations
Mutably borrows from an owned value. Read more