Struct Bitmap16

Source
pub struct Bitmap16(/* private fields */);
Expand description

A bitmap of length 16.

§Examples

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

let mut bitmap = Bitmap16::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_u16());

// Let's do the same as above, but actually setting the values in the bitmap to something
bitmap |= Bitmap16::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 < 16
bitmap.set(4, true).unwrap();

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

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

Implementations§

Source§

impl Bitmap16

Source

pub fn capacity() -> usize

Source

pub fn to_u16(&self) -> u16

Source

pub fn new(value: bool) -> Bitmap16

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

§Example
use fixed_bitmaps::Bitmap16;

let a = Bitmap16::new(true);
assert_eq!(*a, u16::MAX);

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

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

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::Bitmap16;

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

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

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

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

use fixed_bitmaps::Bitmap16;

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

// The above is equivalent to:

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

assert_eq!(a, b);
Source

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::Bitmap16;

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

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

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::Bitmap16;

let mut bitmap = Bitmap16::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);
Source

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::Bitmap16;

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

Methods from Deref<Target = u16>§

1.43.0 · Source

pub const MIN: u16 = 0u16

1.43.0 · Source

pub const MAX: u16 = 65_535u16

1.53.0 · Source

pub const BITS: u32 = 16u32

Trait Implementations§

Source§

impl Add<u16> for Bitmap16

Source§

type Output = Bitmap16

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

impl Add for Bitmap16

Source§

type Output = Bitmap16

The resulting type after applying the + operator.
Source§

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

Performs the + operation. Read more
Source§

impl AddAssign<u16> for Bitmap16

Source§

fn add_assign(&mut self, rhs: u16)

Performs the += operation. Read more
Source§

impl AddAssign for Bitmap16

Source§

fn add_assign(&mut self, rhs: Self)

Performs the += operation. Read more
Source§

impl BitAnd<u16> for Bitmap16

Source§

type Output = Bitmap16

The resulting type after applying the & operator.
Source§

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

Performs the & operation. Read more
Source§

impl BitAnd for Bitmap16

Source§

type Output = Bitmap16

The resulting type after applying the & operator.
Source§

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

Performs the & operation. Read more
Source§

impl BitAndAssign<u16> for Bitmap16

Source§

fn bitand_assign(&mut self, rhs: u16)

Performs the &= operation. Read more
Source§

impl BitAndAssign for Bitmap16

Source§

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation. Read more
Source§

impl BitOr<u16> for Bitmap16

Source§

type Output = Bitmap16

The resulting type after applying the | operator.
Source§

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

Performs the | operation. Read more
Source§

impl BitOr for Bitmap16

Source§

type Output = Bitmap16

The resulting type after applying the | operator.
Source§

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

Performs the | operation. Read more
Source§

impl BitOrAssign<u16> for Bitmap16

Source§

fn bitor_assign(&mut self, rhs: u16)

Performs the |= operation. Read more
Source§

impl BitOrAssign for Bitmap16

Source§

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation. Read more
Source§

impl BitXor<u16> for Bitmap16

Source§

type Output = Bitmap16

The resulting type after applying the ^ operator.
Source§

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

Performs the ^ operation. Read more
Source§

impl BitXor for Bitmap16

Source§

type Output = Bitmap16

The resulting type after applying the ^ operator.
Source§

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

Performs the ^ operation. Read more
Source§

impl BitXorAssign<u16> for Bitmap16

Source§

fn bitxor_assign(&mut self, rhs: u16)

Performs the ^= operation. Read more
Source§

impl BitXorAssign for Bitmap16

Source§

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation. Read more
Source§

impl BitmapSize for Bitmap16

Source§

const MAP_LENGTH: usize = 16usize

Source§

impl Clone for Bitmap16

Source§

fn clone(&self) -> Bitmap16

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Bitmap16

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Bitmap16

Source§

fn default() -> Bitmap16

Returns the “default value” for a type. Read more
Source§

impl Deref for Bitmap16

Source§

type Target = u16

The resulting type after dereferencing.
Source§

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

Dereferences the value.
Source§

impl<'de> Deserialize<'de> for Bitmap16

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for Bitmap16

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Div<u16> for Bitmap16

Source§

type Output = Bitmap16

The resulting type after applying the / operator.
Source§

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

Performs the / operation. Read more
Source§

impl Div for Bitmap16

Source§

type Output = Bitmap16

The resulting type after applying the / operator.
Source§

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

Performs the / operation. Read more
Source§

impl DivAssign<u16> for Bitmap16

Source§

fn div_assign(&mut self, rhs: u16)

Performs the /= operation. Read more
Source§

impl DivAssign for Bitmap16

Source§

fn div_assign(&mut self, rhs: Self)

Performs the /= operation. Read more
Source§

impl From<u16> for Bitmap16

Source§

fn from(value: u16) -> Self

Converts to this type from the input type.
Source§

impl Hash for Bitmap16

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Mul<u16> for Bitmap16

Source§

type Output = Bitmap16

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

impl Mul for Bitmap16

Source§

type Output = Bitmap16

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

impl MulAssign<u16> for Bitmap16

Source§

fn mul_assign(&mut self, rhs: u16)

Performs the *= operation. Read more
Source§

impl MulAssign for Bitmap16

Source§

fn mul_assign(&mut self, rhs: Self)

Performs the *= operation. Read more
Source§

impl Not for Bitmap16

Source§

type Output = Bitmap16

The resulting type after applying the ! operator.
Source§

fn not(self) -> Self::Output

Performs the unary ! operation. Read more
Source§

impl Ord for Bitmap16

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Bitmap16

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl PartialOrd for Bitmap16

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

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

impl Serialize for Bitmap16

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Shl<usize> for Bitmap16

Source§

type Output = Bitmap16

The resulting type after applying the << operator.
Source§

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

Performs the << operation. Read more
Source§

impl ShlAssign<usize> for Bitmap16

Source§

fn shl_assign(&mut self, rhs: usize)

Performs the <<= operation. Read more
Source§

impl Shr<usize> for Bitmap16

Source§

type Output = Bitmap16

The resulting type after applying the >> operator.
Source§

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

Performs the >> operation. Read more
Source§

impl ShrAssign<usize> for Bitmap16

Source§

fn shr_assign(&mut self, rhs: usize)

Performs the >>= operation. Read more
Source§

impl Sub<u16> for Bitmap16

Source§

type Output = Bitmap16

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

impl Sub for Bitmap16

Source§

type Output = Bitmap16

The resulting type after applying the - operator.
Source§

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

Performs the - operation. Read more
Source§

impl SubAssign<u16> for Bitmap16

Source§

fn sub_assign(&mut self, rhs: u16)

Performs the -= operation. Read more
Source§

impl SubAssign for Bitmap16

Source§

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation. Read more
Source§

impl Copy for Bitmap16

Source§

impl Eq for Bitmap16

Source§

impl StructuralPartialEq for Bitmap16

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,