Struct AtomConnection 

pub struct AtomConnection {
    pub from: AtomIndex,
    pub to: AtomIndex,
    pub order: Option<u8>,
}

A simple connection between explicit atoms.

Fields

from: AtomIndex

The source atom index.

to: AtomIndex

The target atom index.

order: Option<u8>

Optional connection order. This crate does not assign bonding semantics to the value.

Implementations

impl AtomConnection

pub fn new( from: AtomIndex, to: AtomIndex, order: Option<u8>, ) -> Result<AtomConnection, MoleculeValidationError>

Creates an atom connection.

Errors

Returns MoleculeValidationError::SelfConnection when from equals to, or MoleculeValidationError::ZeroConnectionOrder when order is Some(0).

Trait Implementations

impl Clone for AtomConnection

fn clone(&self) -> AtomConnection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AtomConnection

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

Formats the value using the given formatter.

impl Display for AtomConnection

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

Formats the value using the given formatter.

impl Hash for AtomConnection

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

where __H: Hasher,

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 Ord for AtomConnection

fn cmp(&self, other: &AtomConnection) -> 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 AtomConnection

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

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

impl Eq for AtomConnection

impl StructuralPartialEq for AtomConnection