Struct BranchArm 

pub struct BranchArm { /* private fields */ }

Blocks and pipes authored as one arm of a named branch region.

Implementations

impl BranchArm

pub fn new(blocks: Vec<Block>, pipes: Vec<Pipe>) -> Self

Creates an arm. Canonical ordering makes equality and BLOG output stable.

pub fn try_from_blocks<P: Into<IVec3>, K: AsRef<str>>( blocks: impl IntoIterator<Item = (P, K)>, ) -> Result<Self, BlockGraphError>

Creates an arm from position and BLOG block-kind pairs. Use Self::new when blocks need tags, heights, or other properties.

Errors

Returns an error if a block kind is invalid. Geometry is checked when the arm is installed in its parent graph.

pub fn with_pipes(self, pipes: impl IntoIterator<Item = Pipe>) -> Self

Adds explicitly authored pipes to this arm, retaining canonical order.

pub fn blocks(&self) -> impl Iterator<Item = &Block>

Iterates over arm blocks in canonical position order.

pub fn pipes(&self) -> impl Iterator<Item = &Pipe>

Iterates over arm pipes in canonical endpoint order.

pub fn is_empty(&self) -> bool

Returns whether the arm contains no blocks.

pub fn contains_block(&self, position: IVec3) -> bool

Returns whether the arm owns a block anchored at position.

pub fn try_with_shift(&self, offset: IVec3) -> Result<Self, BlockGraphError>

Translate an unmaterialized arm, including its external cut endpoints. Returns an error if a block footprint or pipe endpoint overflows.

Errors

Returns BlockGraphError::CoordinateOverflow for an unrepresentable shift.

pub fn try_with_orientation( &self, orientation: ModuleOrientation, ) -> Result<Self, BlockGraphError>

Rotate an unmaterialized arm with the graph’s block-orientation rules. Returns an error for unsupported orientations or coordinate overflow.

Errors

Returns an orientation or coordinate error if any arm element cannot rotate.

pub fn flip_xz_basis(&self, source: &BlockGraph) -> Self

Swap X/Z bases, including Hadamards at fixed T/Y endpoints. The source graph supplies block kinds at external cut endpoints outside this arm.

Trait Implementations

impl Clone for BranchArm

fn clone(&self) -> BranchArm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BranchArm

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

Formats the value using the given formatter.

impl Default for BranchArm

fn default() -> BranchArm

Returns the “default value” for a type.

impl Eq for BranchArm

impl PartialEq for BranchArm

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for BranchArm