Skip to main content

Atom

Struct Atom 

Source
pub struct Atom { /* private fields */ }
Expand description

A dynamic property bag representing an atom (or bead).

All data — including coordinates ("x", "y", "z"), element symbol, mass, charge, etc. — is stored as key-value pairs.

Implementations§

Source§

impl Atom

Source

pub fn new() -> Atom

Create an empty atom.

Source

pub fn xyz(symbol: &str, x: f64, y: f64, z: f64) -> Atom

Convenience: create an atom with symbol + xyz.

Source

pub fn set(&mut self, key: &str, val: impl Into<PropValue>)

Insert or update a property.

Source

pub fn get(&self, key: &str) -> Option<&PropValue>

Get a reference to a property value.

Source

pub fn get_mut(&mut self, key: &str) -> Option<&mut PropValue>

Get a mutable reference to a property value.

Source

pub fn get_f64(&self, key: &str) -> Option<f64>

Try to read a property as f64.

Source

pub fn get_str(&self, key: &str) -> Option<&str>

Try to read a property as &str.

Source

pub fn get_int(&self, key: &str) -> Option<i32>

Try to read a property as I.

Source

pub fn contains_key(&self, key: &str) -> bool

Check whether a key exists.

Source

pub fn remove(&mut self, key: &str) -> Option<PropValue>

Remove a property, returning its value if present.

Source

pub fn keys(&self) -> impl Iterator<Item = &str>

Iterate over all property keys.

Source

pub fn len(&self) -> usize

Number of properties.

Source

pub fn is_empty(&self) -> bool

Whether there are no properties.

Trait Implementations§

Source§

impl Clone for Atom

Source§

fn clone(&self) -> Atom

Returns a duplicate of the value. Read more
1.0.0 · 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<(), Error>

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

impl Default for Atom

Source§

fn default() -> Atom

Returns the “default value” for a type. Read more
Source§

impl Index<&str> for Atom

Source§

type Output = PropValue

The returned type after indexing.
Source§

fn index(&self, key: &str) -> &<Atom as Index<&str>>::Output

Performs the indexing (container[index]) operation. Read more
Source§

impl IndexMut<&str> for Atom

Source§

fn index_mut(&mut self, key: &str) -> &mut <Atom as Index<&str>>::Output

Performs the mutable indexing (container[index]) operation. 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 · 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 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, 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.