Struct chemfiles::Match

pub struct Match { /* private fields */ }

A Match is a set of atomic indexes matching a given selection. It can mostly be used like a &[usize].

Implementations

impl Match

pub fn len(&self) -> usize

Get the length of the Match.

Example

let atomic_match = Match::new(&[3, 4, 5]);
assert_eq!(atomic_match.len(), 3);

pub fn new(atoms: &[usize]) -> Match

Create a new match containing the atoms in the atoms slice.

Panics

If the slice contains more than 4 elements, which is the maximal size of a match.

Example

let atomic_match = Match::new(&[3, 4, 5]);
assert_eq!(atomic_match.len(), 3);
assert_eq!(atomic_match[0], 3);
assert_eq!(atomic_match[1], 4);
assert_eq!(atomic_match[2], 5);

pub fn iter(&self) -> Iter<'_, usize>

Iterate over the atomic indexes in the match.

Example

let atomic_match = Match::new(&[3, 4, 5]);
let mut iter = atomic_match.iter();

assert_eq!(iter.next(), Some(&3));
assert_eq!(iter.next(), Some(&4));
assert_eq!(iter.next(), Some(&5));
assert_eq!(iter.next(), None);

Trait Implementations

impl Clone for Match

fn clone(&self) -> Match

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Match

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

Formats the value using the given formatter.

impl Index<usize> for Match

type Output = usize

The returned type after indexing.

fn index(&self, i: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for &'a Match

type Item = &'a usize

The type of the elements being iterated over.

type IntoIter = Iter<'a, usize>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Match

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

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

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

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

impl Eq for Match

impl StructuralEq for Match

impl StructuralPartialEq for Match