Struct Bitmap64

pub struct Bitmap64(/* private fields */);

A bitmap of length 64.

Examples

// Creates an empty bitmap
use fixed_bitmaps::Bitmap64;

let mut bitmap = Bitmap64::default();

// Bitmaps implement Display so you can view what the map looks like
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_u64());

// Let's do the same as above, but actually setting the values in the bitmap to something
bitmap |= Bitmap64::from(101);

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 < 64
bitmap.set(4, true).unwrap();

// Will show that 117 (101 + 2^4) is the value of the bitmap
println!("Bitmap value: {}", bitmap.to_u64());

// Or you could use the deref operator for an even easier conversion
println!("Bitmap value: {}", *bitmap);

Implementations

impl Bitmap64

pub fn capacity() -> usize

pub fn to_u64(&self) -> u64

Examples found in repository

examples/using_bitmap64.rs (line 11)

fn main() {
    // Creates an empty bitmap
    let mut bitmap = Bitmap64::default();

    // Bitmaps implement Display so you can view what the map looks like
    println!("Default bitmap: {}", bitmap);

    // Bitmaps also convert to their respective unsigned int versions and back again easily
    println!("Value of bitmap: {}", bitmap.to_u64());

    // Let's do the same as above, but actually setting the values in the bitmap to something
    bitmap |= Bitmap64::from(101);

    // Will show 0000000000000000000000000000000000000000000000000000000001100101
    println!("Bitmap after OR-ing with 101: {}", bitmap);

    // Set the 4th index (the 5th bit) to true. Can simply unwrap the result to remove the warning, as we know
    // for certain that 4 < 63
    bitmap.set(4, true).unwrap();

    // Will show that 117 (101 + 2^4) is the value of the bitmap
    println!("Bitmap value: {}", bitmap.to_u64());

    // Will print out the error thrown when trying to set an index out of bounds
    match bitmap.set(64, true) {
        Ok(_) => println!("That wasn't meant to happen... something's up with my implementation!"),
        Err(error) => {
            println!("Yep, threw an error as expected. Error message is as follows:");
            eprintln!("{}", error);
        }
    }

    // Multiple ways to create a new bitmap
    let _empty = Bitmap64::default();
    let _full = Bitmap64::from(u64::MAX);

    // Equivalent ways to create a bitmap with last bits 1001
    let _bitmap = Bitmap64::from(9);
    let _bitmap = Bitmap64::from(0b1001);

    // Sets the 7th least significant bit when creating a new bitmap (indexing starts at 0)
    let mut bitmap = Bitmap64::from_set(6).unwrap();

    // Use the set() method to work with specific bits
    bitmap.set(6, false).unwrap();
    bitmap.set(42, true).unwrap();

    // Use get() to know the value of a specific bit
    println!("Bit at index 42: {}", bitmap.get(42).unwrap());

    // Freely use boolean operators &, |, and ^
    let bitmap1 = Bitmap64::from(0b1001);
    let bitmap2 = Bitmap64::from(0b1010);

    let _and = bitmap1 & bitmap2;
    let _or = bitmap1 | bitmap2;
    let _xor = bitmap1 ^ bitmap2;

    // Aritmetic operators are currently used as exactly that, the following is guarunteed to continue working as it does
    let _add = bitmap1 + 10;
    let _sub = bitmap1 - 4;
    let _mul = bitmap2 * 2;
    let _div = bitmap2 / 2;

    // The following works exactly as above, but is likely to change in favour of set operations in the major update to 1.0.0
    let _add = bitmap1 + Bitmap64::from(10);
    let _sub = bitmap1 - Bitmap64::from(4);
    let _mul = bitmap2 * Bitmap64::from(2);
    let _div = bitmap2 / Bitmap64::from(2);
}

pub fn new(value: bool) -> Bitmap64

Creates a new bitmap with all bits set to the given value.

Example

use fixed_bitmaps::Bitmap64;

let a = Bitmap64::new(true);
assert_eq!(*a, u64::MAX);

let b = Bitmap64::new(false);
assert_eq!(*b, 0);

pub fn create_bit_mask(begin: usize, end: usize, value: bool) -> Bitmap64

Create a new bitmap that has its bits set from begin (inclusive) to end (exclusive). If begin is greater than the map length or end is 0, will return a bitmap with all bits set to the opposite of value.

Example

use fixed_bitmaps::Bitmap64;

let a = Bitmap64::create_bit_mask(3, 7, true);
assert_eq!(*a, 0b1111000);

let b = Bitmap64::create_bit_mask(3, 6, false); // Results in 1..1000111
assert_eq!(b, Bitmap64::new(true) ^ 0b111000);

pub fn from_set(index: usize) -> Option<Bitmap64>

Creates a new, empty Bitmap64, and sets the desired index before returning.

use fixed_bitmaps::Bitmap64;

let a = Bitmap64::from_set(5).unwrap();

// The above is equivalent to:

let mut b = Bitmap64::from(0);
b.set(5, true);

assert_eq!(a, b);

Examples found in repository

examples/using_bitmap64.rs (line 44)

fn main() {
    // Creates an empty bitmap
    let mut bitmap = Bitmap64::default();

    // Bitmaps implement Display so you can view what the map looks like
    println!("Default bitmap: {}", bitmap);

    // Bitmaps also convert to their respective unsigned int versions and back again easily
    println!("Value of bitmap: {}", bitmap.to_u64());

    // Let's do the same as above, but actually setting the values in the bitmap to something
    bitmap |= Bitmap64::from(101);

    // Will show 0000000000000000000000000000000000000000000000000000000001100101
    println!("Bitmap after OR-ing with 101: {}", bitmap);

    // Set the 4th index (the 5th bit) to true. Can simply unwrap the result to remove the warning, as we know
    // for certain that 4 < 63
    bitmap.set(4, true).unwrap();

    // Will show that 117 (101 + 2^4) is the value of the bitmap
    println!("Bitmap value: {}", bitmap.to_u64());

    // Will print out the error thrown when trying to set an index out of bounds
    match bitmap.set(64, true) {
        Ok(_) => println!("That wasn't meant to happen... something's up with my implementation!"),
        Err(error) => {
            println!("Yep, threw an error as expected. Error message is as follows:");
            eprintln!("{}", error);
        }
    }

    // Multiple ways to create a new bitmap
    let _empty = Bitmap64::default();
    let _full = Bitmap64::from(u64::MAX);

    // Equivalent ways to create a bitmap with last bits 1001
    let _bitmap = Bitmap64::from(9);
    let _bitmap = Bitmap64::from(0b1001);

    // Sets the 7th least significant bit when creating a new bitmap (indexing starts at 0)
    let mut bitmap = Bitmap64::from_set(6).unwrap();

    // Use the set() method to work with specific bits
    bitmap.set(6, false).unwrap();
    bitmap.set(42, true).unwrap();

    // Use get() to know the value of a specific bit
    println!("Bit at index 42: {}", bitmap.get(42).unwrap());

    // Freely use boolean operators &, |, and ^
    let bitmap1 = Bitmap64::from(0b1001);
    let bitmap2 = Bitmap64::from(0b1010);

    let _and = bitmap1 & bitmap2;
    let _or = bitmap1 | bitmap2;
    let _xor = bitmap1 ^ bitmap2;

    // Aritmetic operators are currently used as exactly that, the following is guarunteed to continue working as it does
    let _add = bitmap1 + 10;
    let _sub = bitmap1 - 4;
    let _mul = bitmap2 * 2;
    let _div = bitmap2 / 2;

    // The following works exactly as above, but is likely to change in favour of set operations in the major update to 1.0.0
    let _add = bitmap1 + Bitmap64::from(10);
    let _sub = bitmap1 - Bitmap64::from(4);
    let _mul = bitmap2 * Bitmap64::from(2);
    let _div = bitmap2 / Bitmap64::from(2);
}

pub fn set(&mut self, index: usize, value: bool) -> Result<(), String>

Sets the desired index, to the value provided. Note that indexing starts at 0.

Returns

Returns a Result based on the outcome. If an Err<String> was returned, it was because an out-of-bounds index was attempted to be set. In that case the bitmap’s state remains unchanged.

Example

use fixed_bitmaps::Bitmap64;

let mut bitmap = Bitmap64::default();
assert_eq!(*bitmap, 0);

bitmap.set(4, true);
assert_eq!(*bitmap, 16);

Examples found in repository

examples/using_bitmap64.rs (line 21)

fn main() {
    // Creates an empty bitmap
    let mut bitmap = Bitmap64::default();

    // Bitmaps implement Display so you can view what the map looks like
    println!("Default bitmap: {}", bitmap);

    // Bitmaps also convert to their respective unsigned int versions and back again easily
    println!("Value of bitmap: {}", bitmap.to_u64());

    // Let's do the same as above, but actually setting the values in the bitmap to something
    bitmap |= Bitmap64::from(101);

    // Will show 0000000000000000000000000000000000000000000000000000000001100101
    println!("Bitmap after OR-ing with 101: {}", bitmap);

    // Set the 4th index (the 5th bit) to true. Can simply unwrap the result to remove the warning, as we know
    // for certain that 4 < 63
    bitmap.set(4, true).unwrap();

    // Will show that 117 (101 + 2^4) is the value of the bitmap
    println!("Bitmap value: {}", bitmap.to_u64());

    // Will print out the error thrown when trying to set an index out of bounds
    match bitmap.set(64, true) {
        Ok(_) => println!("That wasn't meant to happen... something's up with my implementation!"),
        Err(error) => {
            println!("Yep, threw an error as expected. Error message is as follows:");
            eprintln!("{}", error);
        }
    }

    // Multiple ways to create a new bitmap
    let _empty = Bitmap64::default();
    let _full = Bitmap64::from(u64::MAX);

    // Equivalent ways to create a bitmap with last bits 1001
    let _bitmap = Bitmap64::from(9);
    let _bitmap = Bitmap64::from(0b1001);

    // Sets the 7th least significant bit when creating a new bitmap (indexing starts at 0)
    let mut bitmap = Bitmap64::from_set(6).unwrap();

    // Use the set() method to work with specific bits
    bitmap.set(6, false).unwrap();
    bitmap.set(42, true).unwrap();

    // Use get() to know the value of a specific bit
    println!("Bit at index 42: {}", bitmap.get(42).unwrap());

    // Freely use boolean operators &, |, and ^
    let bitmap1 = Bitmap64::from(0b1001);
    let bitmap2 = Bitmap64::from(0b1010);

    let _and = bitmap1 & bitmap2;
    let _or = bitmap1 | bitmap2;
    let _xor = bitmap1 ^ bitmap2;

    // Aritmetic operators are currently used as exactly that, the following is guarunteed to continue working as it does
    let _add = bitmap1 + 10;
    let _sub = bitmap1 - 4;
    let _mul = bitmap2 * 2;
    let _div = bitmap2 / 2;

    // The following works exactly as above, but is likely to change in favour of set operations in the major update to 1.0.0
    let _add = bitmap1 + Bitmap64::from(10);
    let _sub = bitmap1 - Bitmap64::from(4);
    let _mul = bitmap2 * Bitmap64::from(2);
    let _div = bitmap2 / Bitmap64::from(2);
}

pub fn set_range(&mut self, begin: usize, end: usize, value: bool)

Set bits from begin (inclusive) to end (exclusive) to the given value.

Example

use fixed_bitmaps::Bitmap64;

let mut bitmap = Bitmap64::default();
assert_eq!(*bitmap, 0);

bitmap.set_range(2, 7, true);
assert_eq!(*bitmap, 0b1111100);

bitmap.set_range(3, 5, false);
assert_eq!(*bitmap, 0b1100100);

pub fn get(&self, index: usize) -> Result<bool, String>

Gets the bit at the given index. Note that indexing starts at 0.

Returns

Returns a Result based on the outcome.

If Ok<bool> is returned, then the contained value in ok is the state of the given bit

If an Err<String> was returned, it was because you tried to get an out-of-bounds index.

Example

use fixed_bitmaps::Bitmap64;

let bitmap = Bitmap64::from(0b1010);
assert_eq!(bitmap.get(2).unwrap(), false);
assert_eq!(bitmap.get(3).unwrap(), true);

Examples found in repository

examples/using_bitmap64.rs (line 51)

fn main() {
    // Creates an empty bitmap
    let mut bitmap = Bitmap64::default();

    // Bitmaps implement Display so you can view what the map looks like
    println!("Default bitmap: {}", bitmap);

    // Bitmaps also convert to their respective unsigned int versions and back again easily
    println!("Value of bitmap: {}", bitmap.to_u64());

    // Let's do the same as above, but actually setting the values in the bitmap to something
    bitmap |= Bitmap64::from(101);

    // Will show 0000000000000000000000000000000000000000000000000000000001100101
    println!("Bitmap after OR-ing with 101: {}", bitmap);

    // Set the 4th index (the 5th bit) to true. Can simply unwrap the result to remove the warning, as we know
    // for certain that 4 < 63
    bitmap.set(4, true).unwrap();

    // Will show that 117 (101 + 2^4) is the value of the bitmap
    println!("Bitmap value: {}", bitmap.to_u64());

    // Will print out the error thrown when trying to set an index out of bounds
    match bitmap.set(64, true) {
        Ok(_) => println!("That wasn't meant to happen... something's up with my implementation!"),
        Err(error) => {
            println!("Yep, threw an error as expected. Error message is as follows:");
            eprintln!("{}", error);
        }
    }

    // Multiple ways to create a new bitmap
    let _empty = Bitmap64::default();
    let _full = Bitmap64::from(u64::MAX);

    // Equivalent ways to create a bitmap with last bits 1001
    let _bitmap = Bitmap64::from(9);
    let _bitmap = Bitmap64::from(0b1001);

    // Sets the 7th least significant bit when creating a new bitmap (indexing starts at 0)
    let mut bitmap = Bitmap64::from_set(6).unwrap();

    // Use the set() method to work with specific bits
    bitmap.set(6, false).unwrap();
    bitmap.set(42, true).unwrap();

    // Use get() to know the value of a specific bit
    println!("Bit at index 42: {}", bitmap.get(42).unwrap());

    // Freely use boolean operators &, |, and ^
    let bitmap1 = Bitmap64::from(0b1001);
    let bitmap2 = Bitmap64::from(0b1010);

    let _and = bitmap1 & bitmap2;
    let _or = bitmap1 | bitmap2;
    let _xor = bitmap1 ^ bitmap2;

    // Aritmetic operators are currently used as exactly that, the following is guarunteed to continue working as it does
    let _add = bitmap1 + 10;
    let _sub = bitmap1 - 4;
    let _mul = bitmap2 * 2;
    let _div = bitmap2 / 2;

    // The following works exactly as above, but is likely to change in favour of set operations in the major update to 1.0.0
    let _add = bitmap1 + Bitmap64::from(10);
    let _sub = bitmap1 - Bitmap64::from(4);
    let _mul = bitmap2 * Bitmap64::from(2);
    let _div = bitmap2 / Bitmap64::from(2);
}

Methods from Deref<Target = u64>

pub const MIN: u64 = 0u64

pub const MAX: u64 = 18_446_744_073_709_551_615u64

pub const BITS: u32 = 64u32

Trait Implementations

impl Add<u64> for Bitmap64

type Output = Bitmap64

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> Self::Output

Performs the + operation.

impl Add for Bitmap64

type Output = Bitmap64

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign<u64> for Bitmap64

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl AddAssign for Bitmap64

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl BitAnd<u64> for Bitmap64

type Output = Bitmap64

The resulting type after applying the & operator.

fn bitand(self, rhs: u64) -> Self::Output

Performs the & operation.

impl BitAnd for Bitmap64

type Output = Bitmap64

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self::Output

Performs the & operation.

impl BitAndAssign<u64> for Bitmap64

fn bitand_assign(&mut self, rhs: u64)

Performs the &= operation.

impl BitAndAssign for Bitmap64

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr<u64> for Bitmap64

type Output = Bitmap64

The resulting type after applying the | operator.

fn bitor(self, rhs: u64) -> Self::Output

Performs the | operation.

impl BitOr for Bitmap64

type Output = Bitmap64

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self::Output

Performs the | operation.

impl BitOrAssign<u64> for Bitmap64

fn bitor_assign(&mut self, rhs: u64)

Performs the |= operation.

impl BitOrAssign for Bitmap64

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor<u64> for Bitmap64

type Output = Bitmap64

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: u64) -> Self::Output

Performs the ^ operation.

impl BitXor for Bitmap64

type Output = Bitmap64

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self::Output

Performs the ^ operation.

impl BitXorAssign<u64> for Bitmap64

fn bitxor_assign(&mut self, rhs: u64)

Performs the ^= operation.

impl BitXorAssign for Bitmap64

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl BitmapSize for Bitmap64

const MAP_LENGTH: usize = 64usize

impl Clone for Bitmap64

fn clone(&self) -> Bitmap64

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Bitmap64

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Bitmap64

fn default() -> Bitmap64

Returns the “default value” for a type.

impl Deref for Bitmap64

type Target = u64

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for Bitmap64

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Bitmap64

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Div<u64> for Bitmap64

type Output = Bitmap64

The resulting type after applying the / operator.

fn div(self, rhs: u64) -> Self::Output

Performs the / operation.

impl Div for Bitmap64

type Output = Bitmap64

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl DivAssign<u64> for Bitmap64

fn div_assign(&mut self, rhs: u64)

Performs the /= operation.

impl DivAssign for Bitmap64

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<u64> for Bitmap64

fn from(value: u64) -> Self

Converts to this type from the input type.

impl Hash for Bitmap64

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul<u64> for Bitmap64

type Output = Bitmap64

The resulting type after applying the * operator.

fn mul(self, rhs: u64) -> Self::Output

Performs the * operation.

impl Mul for Bitmap64

type Output = Bitmap64

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl MulAssign<u64> for Bitmap64

fn mul_assign(&mut self, rhs: u64)

Performs the *= operation.

impl MulAssign for Bitmap64

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl Not for Bitmap64

type Output = Bitmap64

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for Bitmap64

fn cmp(&self, other: &Bitmap64) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Bitmap64

fn eq(&self, other: &Bitmap64) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Bitmap64

fn partial_cmp(&self, other: &Bitmap64) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Bitmap64

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Shl<usize> for Bitmap64

type Output = Bitmap64

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> Self::Output

Performs the << operation.

impl ShlAssign<usize> for Bitmap64

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation.

impl Shr<usize> for Bitmap64

type Output = Bitmap64

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> Self::Output

Performs the >> operation.

impl ShrAssign<usize> for Bitmap64

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation.

impl Sub<u64> for Bitmap64

type Output = Bitmap64

The resulting type after applying the - operator.

fn sub(self, rhs: u64) -> Self::Output

Performs the - operation.

impl Sub for Bitmap64

type Output = Bitmap64

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl SubAssign<u64> for Bitmap64

fn sub_assign(&mut self, rhs: u64)

Performs the -= operation.

impl SubAssign for Bitmap64

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Bitmap64

impl Eq for Bitmap64

impl StructuralPartialEq for Bitmap64