Struct castep_model_core::atom::AtomCollectionBuilder
source · pub struct AtomCollectionBuilder<T, S>where
T: ModelInfo,
S: BuildState,{ /* private fields */ }Implementations§
source§impl<T: ModelInfo, S: BuildState> AtomCollectionBuilder<T, S>
impl<T: ModelInfo, S: BuildState> AtomCollectionBuilder<T, S>
pub fn new(size: usize) -> AtomCollectionBuilder<T, No>
sourcepub fn with_element_symbols(
self,
element_symbols: &[String]
) -> Result<Self, AtomCollectionBuildingError>
pub fn with_element_symbols( self, element_symbols: &[String] ) -> Result<Self, AtomCollectionBuildingError>
Supply the element_symbols for an AtomCollection.
Errors
This function will return an error if the element_ids has a different vector size
with the builder’s given size.
sourcepub fn with_atomic_nums(
self,
atomic_nums: &[u8]
) -> Result<Self, AtomCollectionBuildingError>
pub fn with_atomic_nums( self, atomic_nums: &[u8] ) -> Result<Self, AtomCollectionBuildingError>
Supply the atomic_nums for an AtomCollection.
Errors
This function will return an error if the element_ids has a different vector size
with the builder’s given size.
sourcepub fn with_xyz_coords(
self,
xyz_coords: &[Point3<f64>]
) -> Result<Self, AtomCollectionBuildingError>
pub fn with_xyz_coords( self, xyz_coords: &[Point3<f64>] ) -> Result<Self, AtomCollectionBuildingError>
Supply the xyz_coords for an AtomCollection.
Errors
This function will return an error if the xyz_coords has a different vector size
with the builder’s given size.
sourcepub fn with_fractional_xyz(
self,
fractional_xyz: &[Option<Point3<f64>>]
) -> Result<Self, AtomCollectionBuildingError>
pub fn with_fractional_xyz( self, fractional_xyz: &[Option<Point3<f64>>] ) -> Result<Self, AtomCollectionBuildingError>
Supply the fractional_xyz for an AtomCollection.
Errors
This function will return an error if the fractional_xyz has a different vector size
with the builder’s given size.
sourcepub fn with_atom_ids(
self,
atom_ids: &[u32]
) -> Result<Self, AtomCollectionBuildingError>
pub fn with_atom_ids( self, atom_ids: &[u32] ) -> Result<Self, AtomCollectionBuildingError>
Supply the atom_ids for an AtomCollection.
Errors
This function will return an error if the atom_ids has a different vector size
with the builder’s given size.
pub fn finish( self ) -> Result<AtomCollectionBuilder<T, Ready>, AtomCollectionBuildingError>
source§impl<T: ModelInfo> AtomCollectionBuilder<T, Ready>
impl<T: ModelInfo> AtomCollectionBuilder<T, Ready>
pub fn build(self) -> AtomCollection<T>
Auto Trait Implementations§
impl<T, S> RefUnwindSafe for AtomCollectionBuilder<T, S>where S: RefUnwindSafe, T: RefUnwindSafe,
impl<T, S> Send for AtomCollectionBuilder<T, S>where S: Send, T: Send,
impl<T, S> Sync for AtomCollectionBuilder<T, S>where S: Sync, T: Sync,
impl<T, S> Unpin for AtomCollectionBuilder<T, S>where S: Unpin, T: Unpin,
impl<T, S> UnwindSafe for AtomCollectionBuilder<T, S>where S: UnwindSafe, T: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Pointable for T
impl<T> Pointable for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.