Struct StructureBuilder 

pub struct StructureBuilder { /* private fields */ }

Builder for a Structure.

Implementations

impl StructureBuilder

pub fn new(name: impl Into<String>, lattice: Lattice) -> Self

Starts a P1 structure.

pub fn hall(self, hall: impl Into<String>) -> Self

Sets the Hall symbol.

pub fn site(self, site: Site) -> Self

Adds a site.

pub fn operation(self, operation: SymOp) -> Self

Adds an explicit symmetry operation.

pub fn explicit_bond(self, bond: ExplicitBond) -> Self

Adds an explicit bond or removal.

pub fn topology_bond(self, bond: TopologyBond) -> Self

Adds a topology edge.

pub fn metadata(self, key: impl Into<String>, value: Value) -> Self

Adds one metadata entry.

pub fn build(self) -> Result<Structure, Error>

Builds the structure.

Errors

Returns Error::InvalidInput when the Hall symbol is empty after trimming.

Trait Implementations

impl Clone for StructureBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StructureBuilder

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

Formats the value using the given formatter.