Struct PatchRotationKind 

pub struct PatchRotationKind { /* private fields */ }

A patch-rotation block: rotates a surface code patch by 90 degrees over one time layer, translating it by an axis-aligned movement step.

Implementations

impl PatchRotationKind

pub const DEFAULT: Self

The default X-basis rotation moving one cell in +x.

pub fn new(basis: Basis, movement: IVec2) -> Result<Self, BlockError>

Constructs a patch-rotation kind, validating the movement vector.

Errors

Returns BlockError::InvalidPatchRotationMovement unless movement is a unit step along exactly one of the x or y axes.

pub const fn basis(self) -> Basis

Returns the patch’s starting boundary basis.

pub const fn x_axis_boundary_basis(self) -> Basis

Returns the boundary basis on the x axis, flipped when the block moves along x (the rotation swaps the two boundary orientations).

pub const fn movement(self) -> IVec2

Returns the axis-aligned in-plane displacement.

pub const fn movement_3d(self) -> IVec3

Returns the movement as a 3D vector with +1 on the time axis.

pub const fn with_basis(self, basis: Basis) -> Self

Returns a copy with a different basis.

pub fn end_position(self, start: IVec3) -> IVec3

Returns the end cell reached from start.

Panics

Panics if the endpoint exceeds the coordinate range. Use try_end_position for untrusted positions.

pub fn try_end_position(self, start: IVec3) -> Result<IVec3, BlockGraphError>

Returns the end cell reached from start.

Errors

Returns BlockGraphError::CoordinateOverflow if the endpoint exceeds the coordinate range.

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

Returns the two exposed connection endpoints (start and end) as offsets.

pub fn reserved_offsets(self) -> Vec<IVec3>

Returns every cell the block reserves, as offsets from its position.

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

Returns the boundary bases exposed at endpoint, or None if endpoint is neither the start nor end cell. The bases flip between the two ends.

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

Returns the bases on the pipe face at endpoint, or None if endpoint is neither the start nor end cell.

Unlike bases_at_endpoint, the pipe face uses the block’s construction basis directly rather than the x-axis boundary basis.

Trait Implementations

impl Clone for PatchRotationKind

fn clone(&self) -> PatchRotationKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PatchRotationKind

impl Debug for PatchRotationKind

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

Formats the value using the given formatter.

impl Default for PatchRotationKind

fn default() -> Self

Returns the “default value” for a type.

impl Eq for PatchRotationKind

impl Hash for PatchRotationKind

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 PatchRotationKind

fn cmp(&self, other: &Self) -> 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 PatchRotationKind

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PatchRotationKind

fn partial_cmp(&self, other: &Self) -> 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 PatchRotationKind