[]Struct lumol::BondDistances

pub struct BondDistances { /* fields omitted */ }

The BondDistances bitflag encode the topological distance between two particles in the molecule, i.e. the number of bonds between the particles. Two particles can have multiple bond path lionking them (in the case of cyclic molecules), which is why a bit flag is used instead of a single distance value.

Implementations

impl BondDistances

pub const ONE: BondDistances

The particles are separated by one bond

pub const TWO: BondDistances

The particles are separated by two bonds

pub const THREE: BondDistances

The particles are separated by three bonds

pub const FAR: BondDistances

The particles are separated by more than three bonds

pub const fn empty() -> BondDistances

Returns an empty set of flags

pub const fn all() -> BondDistances

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<BondDistances>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u8) -> BondDistances

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u8) -> BondDistances

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: BondDistances) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: BondDistances) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: BondDistances)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: BondDistances)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: BondDistances)

Toggles the specified flags in-place.

pub fn set(&mut self, other: BondDistances, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for BondDistances

impl BitAnd<BondDistances> for BondDistances

type Output = BondDistances

The resulting type after applying the & operator.

pub fn bitand(self, other: BondDistances) -> BondDistances

Returns the intersection between the two sets of flags.

impl BitAndAssign<BondDistances> for BondDistances

pub fn bitand_assign(&mut self, other: BondDistances)

Disables all flags disabled in the set.

impl BitOr<BondDistances> for BondDistances

type Output = BondDistances

The resulting type after applying the | operator.

pub fn bitor(self, other: BondDistances) -> BondDistances

Returns the union of the two sets of flags.

impl BitOrAssign<BondDistances> for BondDistances

pub fn bitor_assign(&mut self, other: BondDistances)

Adds the set of flags.

impl BitXor<BondDistances> for BondDistances

type Output = BondDistances

The resulting type after applying the ^ operator.

pub fn bitxor(self, other: BondDistances) -> BondDistances

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<BondDistances> for BondDistances

pub fn bitxor_assign(&mut self, other: BondDistances)

Toggles the set of flags.

impl Clone for BondDistances

impl Copy for BondDistances

impl Debug for BondDistances

impl Default for BondDistances

impl Eq for BondDistances

impl Extend<BondDistances> for BondDistances

impl FromIterator<BondDistances> for BondDistances

impl Hash for BondDistances

impl LowerHex for BondDistances

impl Not for BondDistances

type Output = BondDistances

The resulting type after applying the ! operator.

pub fn not(self) -> BondDistances

Returns the complement of this set of flags.

impl Octal for BondDistances

impl Ord for BondDistances

impl PartialEq<BondDistances> for BondDistances

impl PartialOrd<BondDistances> for BondDistances

impl StructuralEq for BondDistances

impl StructuralPartialEq for BondDistances

impl Sub<BondDistances> for BondDistances

type Output = BondDistances

The resulting type after applying the - operator.

pub fn sub(self, other: BondDistances) -> BondDistances

Returns the set difference of the two sets of flags.

impl SubAssign<BondDistances> for BondDistances

pub fn sub_assign(&mut self, other: BondDistances)

Disables all flags enabled in the set.

impl UpperHex for BondDistances

Auto Trait Implementations

impl RefUnwindSafe for BondDistances

impl Send for BondDistances

impl Sync for BondDistances

impl Unpin for BondDistances

impl UnwindSafe for BondDistances

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> Pointable for T

type Init = T

The type for initializers.

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,