Enum CubeKind 

pub enum CubeKind {
    XZZ,
    ZXZ,
    ZZX,
    ZXX,
    XZX,
    XXZ,
}

A cube block’s boundary orientation, named by the Pauli basis (X or Z) assigned to each of the three axes in order.

Variants

XZZ

X boundary on x; Z boundaries on y and z.

ZXZ

Z boundary on x; X boundary on y; Z boundary on z.

ZZX

Z boundaries on x and y; X boundary on z.

ZXX

Z boundary on x; X boundaries on y and z.

XZX

X boundaries on x and z; Z boundary on y.

XXZ

X boundaries on x and y; Z boundary on z.

Implementations

impl CubeKind

pub const fn bases(&self) -> [Basis; 3]

Returns the per-axis boundary bases in [x, y, z] order.

pub const fn normal_direction(&self) -> UDirection

Returns the axis whose basis differs from the other two (the correlation surface normal).

pub const fn normal_basis(&self) -> Basis

Returns the basis on the normal_direction axis.

pub const fn is_x_type(&self) -> bool

Returns whether the normal-axis boundary is X-type.

pub const fn x(&self) -> Basis

Returns the boundary basis on the x axis.

pub const fn y(&self) -> Basis

Returns the boundary basis on the y axis.

pub const fn z(&self) -> Basis

Returns the boundary basis on the z axis.

pub const fn is_spatial(&self) -> bool

Returns whether the cube’s normal lies along the time (Z) axis, making it a spatial rather than temporal boundary.

Trait Implementations

impl Clone for CubeKind

fn clone(&self) -> CubeKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CubeKind

impl Debug for CubeKind

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

Formats the value using the given formatter.

impl Display for CubeKind

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

Formats the value using the given formatter.

impl Eq for CubeKind

impl From<WalkingBoundaryKind> for CubeKind

fn from(kind: WalkingBoundaryKind) -> Self

Converts to this type from the input type.

impl FromStr for CubeKind

type Err = ParseError

The associated error which can be returned from parsing.

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

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

impl Hash for CubeKind

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 CubeKind

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for CubeKind

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

impl TryFrom<&str> for CubeKind

type Error = ParseError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<CubeKind, <Self as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<CubeKind> for WalkingBoundaryKind

type Error = BlockError

The type returned in the event of a conversion error.

fn try_from(kind: CubeKind) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<[Basis; 3]> for CubeKind

type Error = BlockError

The type returned in the event of a conversion error.

fn try_from(bases: [Basis; 3]) -> Result<Self, Self::Error>

Performs the conversion.