Struct fixed_bitmaps::Bitmap64

pub struct Bitmap64(_);

A bitmap of length 64. This would be the most commonly used one, and fastest on 64-bit architectures.

Examples

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

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

// 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 is the value of the bitmap
println!("Bitmap value: {}", bitmap.to_u64());

Implementations

impl Bitmap64

pub fn to_u64(&self) -> u64

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

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

This is equivalent to:

let mut bitmap = Bitmap64::from(0);
bitmap.set(index);

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

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

Trait Implementations

impl Add<Bitmap64> for Bitmap64

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<u64> for Bitmap64

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Bitmap64> for Bitmap64

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl AddAssign<u64> for Bitmap64

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl BitAnd<Bitmap64> for Bitmap64

type Output = Self

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAnd<u64> for Bitmap64

type Output = Self

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign<Bitmap64> for Bitmap64

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitAndAssign<u64> for Bitmap64

fn bitand_assign(&mut self, rhs: u64)

Performs the &= operation.

impl BitOr<Bitmap64> for Bitmap64

type Output = Self

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOr<u64> for Bitmap64

type Output = Self

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign<Bitmap64> for Bitmap64

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitOrAssign<u64> for Bitmap64

fn bitor_assign(&mut self, rhs: u64)

Performs the |= operation.

impl BitXor<Bitmap64> for Bitmap64

type Output = Self

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXor<u64> for Bitmap64

type Output = Self

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign<Bitmap64> for Bitmap64

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl BitXorAssign<u64> for Bitmap64

fn bitxor_assign(&mut self, rhs: u64)

Performs the ^= operation.

impl Clone for Bitmap64

fn clone(&self) -> Bitmap64

Returns a copy 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<'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<Bitmap64> for Bitmap64

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<u64> for Bitmap64

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<Bitmap64> for Bitmap64

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl DivAssign<u64> for Bitmap64

fn div_assign(&mut self, rhs: u64)

Performs the /= operation.

impl From<u64> for Bitmap64

fn from(value: u64) -> Self

Performs the conversion.

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, 

Feeds a slice of this type into the given Hasher.

impl Mul<Bitmap64> for Bitmap64

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<u64> for Bitmap64

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<Bitmap64> for Bitmap64

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation.

impl MulAssign<u64> for Bitmap64

fn mul_assign(&mut self, rhs: u64)

Performs the *= 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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Bitmap64> for Bitmap64

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Bitmap64> 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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method 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 Sub<Bitmap64> for Bitmap64

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<u64> for Bitmap64

type Output = Self

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Bitmap64> for Bitmap64

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl SubAssign<u64> for Bitmap64

fn sub_assign(&mut self, rhs: u64)

Performs the -= operation.

impl Copy for Bitmap64

impl Eq for Bitmap64

impl StructuralEq for Bitmap64

impl StructuralPartialEq for Bitmap64