Struct ElementMask 

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

Struct representing a set of elements as a bitmask.

Each bit in the u128 corresponds to an element in the periodic table, with the least significant bit representing Hydrogen (H, atomic number 1) and the most significant bit representing Oganesson (Og, atomic number 118).

Implementations

impl ElementMask

pub fn contains(&self, element: Element) -> bool

Returns whether the bitmask contains the specified element.

Arguments

• element - The element to check for in the bitmask.

Examples

use elements_rs::{Element, ElementMask};

let mut mask = ElementMask::default();
mask.insert(Element::H);
assert!(mask.contains(Element::H));
assert!(!mask.contains(Element::He));

pub fn insert(&mut self, element: Element) -> bool

Inserts an element into the bitmask and returns whether the element was not already present.

Arguments

• element - The element to insert into the bitmask.

Examples

use elements_rs::{Element, ElementMask};

let mut mask = ElementMask::default();
assert!(mask.insert(Element::H)); // Was not present
assert!(!mask.insert(Element::H)); // Already present

Trait Implementations

impl Clone for ElementMask

fn clone(&self) -> ElementMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElementMask

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

Formats the value using the given formatter.

impl Default for ElementMask

fn default() -> ElementMask

Returns the “default value” for a type.

impl From<Element> for ElementMask

fn from(element: Element) -> Self

Examples

use elements_rs::{Element, ElementMask};

let mask: ElementMask = Element::H.into();
assert!(mask.contains(Element::H));

impl FromIterator<Element> for ElementMask

fn from_iter<T: IntoIterator<Item = Element>>(iter: T) -> Self

Examples

use elements_rs::{Element, ElementMask};

let elements = alloc::vec![Element::H, Element::He];
let mask: ElementMask = elements.into_iter().collect();
assert!(mask.contains(Element::H));
assert!(mask.contains(Element::He));

impl Hash for ElementMask

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 IntoIterator for ElementMask

fn into_iter(self) -> Self::IntoIter

Examples

use elements_rs::{Element, ElementMask};

let mut mask = ElementMask::default();
mask.insert(Element::H);
mask.insert(Element::He);
let elements: Vec<Element> = mask.into_iter().collect();
assert_eq!(elements, alloc::vec![Element::H, Element::He]);

type Item = Element

The type of the elements being iterated over.

type IntoIter = ElementMaskIterator

Which kind of iterator are we turning this into?

impl PartialEq for ElementMask

fn eq(&self, other: &ElementMask) -> 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 Copy for ElementMask

impl Eq for ElementMask

impl StructuralPartialEq for ElementMask