Skip to main content

Atom

Struct Atom 

Source
pub struct Atom {
    pub element: Element,
    pub isotope: Option<u16>,
    pub charge: i8,
    pub hydrogen_count: Option<u8>,
    pub aromatic: bool,
    pub chirality: Chirality,
    pub wildcard: bool,
    pub atom_map: Option<u16>,
    pub cip_code: Option<CipCode>,
}
Expand description

A single atom in a molecular graph.

  • isotope: mass number (e.g. 13 for ¹³C). None = natural isotope abundance.
  • charge: formal charge.
  • hydrogen_count: explicit H count from a bracket atom [...]. None for organic-subset atoms whose H count is inferred from valence.
  • aromatic: set when the atom is written as a lowercase letter (c, n, …) or connected via : bonds.
  • wildcard: true for the SMILES * atom (any element, query context).
  • atom_map: atom-mapping number used in reaction SMILES.
  • cip_code: CIP stereodescriptor (R/S/E/Z). Populated by chematic_chem::assign_cip; None until then.

Fields§

§element: Element§isotope: Option<u16>§charge: i8§hydrogen_count: Option<u8>

Explicit H count (bracket atoms only). None for organic-subset atoms.

§aromatic: bool§chirality: Chirality§wildcard: bool

True for the wildcard atom * or [*].

§atom_map: Option<u16>§cip_code: Option<CipCode>

CIP stereodescriptor assigned by chematic_chem::assign_cip. None until explicitly computed.

Implementations§

Source§

impl Atom

Source

pub fn new(element: Element) -> Self

Create a plain, neutral, non-aromatic atom.

Source

pub fn organic(element: Element) -> Self

Organic-subset atom (charge=0, non-aromatic, implicit H from valence).

Source

pub fn aromatic(element: Element) -> Self

Aromatic organic atom (lowercase SMILES notation).

Source

pub fn bracket( element: Element, isotope: Option<u16>, chirality: Chirality, hydrogen_count: u8, charge: i8, atom_map: Option<u16>, ) -> Self

Bracket atom with explicit properties.

Source

pub fn wildcard() -> Self

Wildcard atom * / [*] (matches any element in query contexts).

Source

pub fn explicit_hcount(&self) -> Option<u8>

Return the explicit H count for bracket atoms; None for organic-subset atoms.

Trait Implementations§

Source§

impl Clone for Atom

Source§

fn clone(&self) -> Atom

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Atom

Source§

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

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

impl Display for Atom

Source§

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

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

impl PartialEq for Atom

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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 Eq for Atom

Source§

impl StructuralPartialEq for Atom

Auto Trait Implementations§

§

impl Freeze for Atom

§

impl RefUnwindSafe for Atom

§

impl Send for Atom

§

impl Sync for Atom

§

impl Unpin for Atom

§

impl UnsafeUnpin for Atom

§

impl UnwindSafe for Atom

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<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.