Enum BlockKind 

pub enum BlockKind {
    Cube(CubeKind),
    Walking(WalkingKind),
    PatchRotation(PatchRotationKind),
    Y,
    Measurement(Basis),
    Port,
    T,
    Selective(SelectiveKind),
}

The kind of a Block, determining its surface code semantics and lattice footprint.

Variants

Cube(CubeKind)

A single-cell cube with a fixed boundary orientation.

Walking(WalkingKind)

A patch that walks diagonally by one cell over one time layer.

PatchRotation(PatchRotationKind)

A patch that rotates 90 degrees over one time layer.

Y

A Y-basis state injection block.

Measurement(Basis)

A fixed terminal transversal measurement in the X or Z basis.

Port

An open connection endpoint (graph input or output).

T

A T-state (magic state) block, lowered via cultivation.

Selective(SelectiveKind)

A selective measurement/preparation block resolved at runtime.

Implementations

impl BlockKind

pub const fn is_cube(&self) -> bool

Returns whether this is a cube block.

pub const fn is_walking(&self) -> bool

Returns whether this is a walking block.

pub const fn is_patch_rotation(&self) -> bool

Returns whether this is a patch-rotation block.

pub const fn is_port(&self) -> bool

Returns whether this is an open port.

pub const fn is_y(&self) -> bool

Returns whether this is a Y-state block.

pub const fn is_measurement(&self) -> bool

Returns whether this is a fixed terminal measurement.

pub const fn is_t(&self) -> bool

Returns whether this is a T-state block.

pub const fn is_selective(&self) -> bool

Returns whether this is a runtime-selective block.

pub const fn is_dynamic(&self) -> bool

Returns whether the block’s behavior is resolved at runtime (selective or T blocks) rather than fixed at compile time.

pub fn flip_xz_basis(self) -> Self

Returns a copy with every X and Z boundary basis swapped.

Panics

Panics if an internally stored cube kind violates its basis invariant.

pub const fn is_clifford(&self) -> bool

Returns whether the block is Clifford (everything except the T block).

pub const fn all_kinds() -> [BlockKind; 16]

Returns one representative of every block kind, using default parameters for the parameterized kinds.

pub fn reserved_offsets(self) -> SmallVec<[IVec3; 2]>

Returns the cells the kind reserves, as offsets from its position.

Cube height is applied per-block by Block::reserved_offsets, so the single-cell kinds here reserve only the origin.

pub fn allows_reserved_overlap( self, self_pos: IVec3, other: BlockKind, other_pos: IVec3, overlap_pos: IVec3, ) -> bool

Returns whether two blocks may both reserve overlap_pos.

Only walking blocks permit shared reserved cells, and never at a hard endpoint of either block.

pub fn connectable_offsets(self) -> SmallVec<[IVec3; 2]>

Returns the cells that can host pipe connections, as offsets from the block position.

pub fn bases(self) -> Option<[Basis; 3]>

Returns the block’s per-axis boundary bases, or None for kinds without a fixed boundary frame (Y, measurement, Port, T, and selective blocks).

pub fn bases_at_endpoint( self, block_pos: IVec3, endpoint: IVec3, ) -> Option<[Basis; 3]>

Returns the boundary bases exposed at endpoint, or None if the block exposes no connectable endpoint there.

pub fn pipe_face_bases_at_endpoint( self, block_pos: IVec3, endpoint: IVec3, ) -> Option<[Basis; 3]>

Returns the bases on the pipe face at endpoint.

Matches bases_at_endpoint except for patch rotation, whose pipe face uses the construction basis directly.

Trait Implementations

impl Clone for BlockKind

fn clone(&self) -> BlockKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BlockKind

impl Debug for BlockKind

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

Formats the value using the given formatter.

impl Default for BlockKind

fn default() -> BlockKind

Returns the “default value” for a type.

impl Display for BlockKind

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

Formats the value using the given formatter.

impl Eq for BlockKind

impl FromStr for BlockKind

type Err = BlockError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for BlockKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for BlockKind

fn cmp(&self, other: &BlockKind) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for BlockKind

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for BlockKind

fn partial_cmp(&self, other: &BlockKind) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for BlockKind