Struct Pipe 

pub struct Pipe { /* private fields */ }

A directed pipe connecting one block to an adjacent block.

Examples

use bloq_graph::{Direction, Pipe};
use glam::IVec3;

let pipe = Pipe::new(IVec3::ZERO, Direction::ZPLUS)
    .with_hadamard()
    .with_tag("bridge")?;
assert_eq!(pipe.src(), IVec3::ZERO);
assert_eq!(pipe.dir(), Direction::ZPLUS);
assert!(pipe.is_hadamard());
assert_eq!(pipe.tag(), Some("bridge"));

Implementations

impl Pipe

pub fn new(src: impl Into<IVec3>, dir: impl Into<Direction>) -> Self

Create an untagged, non-Hadamard pipe.

pub fn src(&self) -> IVec3

Returns the pipe’s canonical source position.

pub fn dir(&self) -> Direction

Returns the direction from source to destination.

pub fn is_hadamard(&self) -> bool

Returns whether the pipe carries a Hadamard basis change.

pub fn tag(&self) -> Option<&str>

Returns the nonempty user tag, if present.

pub fn with_hadamard(self) -> Self

Returns this pipe marked as a Hadamard pipe.

pub fn with_tag(self, tag: impl Into<String>) -> Result<Self, BlockGraphError>

Returns the pipe tagged with tag. An empty tag clears the tag.

Errors

Returns BlockGraphError::InvalidTag unless tag is empty or satisfies is_valid_tag; an invalid tag would not survive a to_blog_text round-trip.

pub fn endpoints(&self) -> (IVec3, IVec3)

Returns the source and destination positions as a (src, dst) pair.

Panics

Panics if stepping from the source exceeds the coordinate range. Use try_endpoints for untrusted pipes.

pub fn try_endpoints(&self) -> Result<(IVec3, IVec3), BlockGraphError>

Returns the source and destination positions as a (src, dst) pair.

Errors

Returns BlockGraphError::CoordinateOverflow if stepping from the source exceeds the coordinate range.

pub fn dst(&self) -> IVec3

Returns the destination position (src stepped one cell along dir).

Panics

Panics if stepping from the source exceeds the coordinate range. Use try_dst for untrusted pipes.

pub fn try_dst(&self) -> Result<IVec3, BlockGraphError>

Returns the destination position (src stepped one cell along dir).

Errors

Returns BlockGraphError::CoordinateOverflow if stepping from the source exceeds the coordinate range.

pub fn with_shift(&self, offset: impl Into<IVec3>) -> Self

Returns a copy of the pipe translated by offset.

Panics

Panics if either translated endpoint exceeds the coordinate range. Use try_with_shift for untrusted offsets.

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

Returns a copy of the pipe translated by offset.

Errors

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

Trait Implementations

impl Clone for Pipe

fn clone(&self) -> Pipe

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pipe

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

Formats the value using the given formatter.

impl Default for Pipe

fn default() -> Pipe

Returns the “default value” for a type.

impl Display for Pipe

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

Formats the value using the given formatter.

impl Eq for Pipe

impl Hash for Pipe

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 PartialEq for Pipe

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Pipe