pub struct FatNode<'hugr, OT = OpType, H = Hugr, N = Node>where
H: ?Sized,{ /* private fields */ }
Expand description
A Fat Node is a Node along with a reference to the HugrView
whence it
originates. It carries a type OT
, the OpType
of that node. OT
may be
general, i.e. exactly OpType
, or specifec, e.g. FuncDefn
.
We provide a [Deref<Target=OT>] impl, so it can be used in place of OT
.
We provide PartialEq
, Eq, PartialOrd
, Ord, Hash, so that this type
can be used in containers. Note that these implementations use only the
stored node, so will silently malfunction if used with FatNode
s from
different base Hugrs. Note that Node has this same behaviour.
Implementations§
Source§impl<'hugr, OT, H: HugrView + ?Sized> FatNode<'hugr, OT, H, H::Node>
impl<'hugr, OT, H: HugrView + ?Sized> FatNode<'hugr, OT, H, H::Node>
Source§impl<'hugr, H: HugrView + ?Sized> FatNode<'hugr, OpType, H, H::Node>
impl<'hugr, H: HugrView + ?Sized> FatNode<'hugr, OpType, H, H::Node>
Sourcepub fn new_optype(hugr: &'hugr H, node: H::Node) -> Self
pub fn new_optype(hugr: &'hugr H, node: H::Node) -> Self
Sourcepub fn try_into_ot<OT>(&self) -> Option<FatNode<'hugr, OT, H, H::Node>>
pub fn try_into_ot<OT>(&self) -> Option<FatNode<'hugr, OT, H, H::Node>>
Tries to downcast a general FatNode
into a specific OT
.
Sourcepub fn into_ot<OT>(self, ot: &OT) -> FatNode<'hugr, OT, H, H::Node>
pub fn into_ot<OT>(self, ot: &OT) -> FatNode<'hugr, OT, H, H::Node>
Creates a specific FatNode
from a general FatNode
.
Panics if the node is not valid in the Hugr
or if its get_optype
is
not an OT
.
Note that while we do check the type of the node’s get_optype
, we
do not verify that it is actually equal to ot
.
Source§impl<'hugr, OT, H: HugrView + ?Sized> FatNode<'hugr, OT, H, H::Node>
impl<'hugr, OT, H: HugrView + ?Sized> FatNode<'hugr, OT, H, H::Node>
Sourcepub fn single_linked_output(
&self,
port: IncomingPort,
) -> Option<(FatNode<'hugr, OpType, H, H::Node>, OutgoingPort)>
pub fn single_linked_output( &self, port: IncomingPort, ) -> Option<(FatNode<'hugr, OpType, H, H::Node>, OutgoingPort)>
If there is exactly one OutgoingPort
connected to this IncomingPort
,
return it and its node.
Sourcepub fn out_value_types(
&self,
) -> impl Iterator<Item = (OutgoingPort, Type)> + 'hugr + use<'hugr, OT, H>
pub fn out_value_types( &self, ) -> impl Iterator<Item = (OutgoingPort, Type)> + 'hugr + use<'hugr, OT, H>
Iterator over all incoming ports that have Value type, along with corresponding types.
Sourcepub fn in_value_types(
&self,
) -> impl Iterator<Item = (IncomingPort, Type)> + 'hugr + use<'hugr, OT, H>
pub fn in_value_types( &self, ) -> impl Iterator<Item = (IncomingPort, Type)> + 'hugr + use<'hugr, OT, H>
Iterator over all incoming ports that have Value type, along with corresponding types.
Sourcepub fn children(
&self,
) -> impl Iterator<Item = FatNode<'hugr, OpType, H, H::Node>> + 'hugr + use<'hugr, OT, H>
pub fn children( &self, ) -> impl Iterator<Item = FatNode<'hugr, OpType, H, H::Node>> + 'hugr + use<'hugr, OT, H>
Return iterator over the direct children of node.
Sourcepub fn get_io(
&self,
) -> Option<(FatNode<'hugr, Input, H, H::Node>, FatNode<'hugr, Output, H, H::Node>)>
pub fn get_io( &self, ) -> Option<(FatNode<'hugr, Input, H, H::Node>, FatNode<'hugr, Output, H, H::Node>)>
Get the input and output child nodes of a dataflow parent. If the node isn’t a dataflow parent, then return None
Sourcepub fn node_outputs(
&self,
) -> impl Iterator<Item = OutgoingPort> + 'hugr + use<'hugr, OT, H>
pub fn node_outputs( &self, ) -> impl Iterator<Item = OutgoingPort> + 'hugr + use<'hugr, OT, H>
Iterator over output ports of node.
Source§impl<'hugr, H: HugrView> FatNode<'hugr, CFG, H, H::Node>
impl<'hugr, H: HugrView> FatNode<'hugr, CFG, H, H::Node>
Sourcepub fn get_entry_exit(
&self,
) -> (FatNode<'hugr, DataflowBlock, H, H::Node>, FatNode<'hugr, ExitBlock, H, H::Node>)
pub fn get_entry_exit( &self, ) -> (FatNode<'hugr, DataflowBlock, H, H::Node>, FatNode<'hugr, ExitBlock, H, H::Node>)
Returns the entry and exit nodes of a CFG.
These are guaranteed to exist the Hugr
is valid. Panics if they do not
exist.
Trait Implementations§
Source§impl<OT, H, N: Ord> Ord for FatNode<'_, OT, H, N>
impl<OT, H, N: Ord> Ord for FatNode<'_, OT, H, N>
Source§impl<N: PartialEq, OT1, OT2, H1, H2> PartialEq<FatNode<'_, OT1, H1, N>> for FatNode<'_, OT2, H2, N>
impl<N: PartialEq, OT1, OT2, H1, H2> PartialEq<FatNode<'_, OT1, H1, N>> for FatNode<'_, OT2, H2, N>
Source§impl<OT, H> PartialOrd<FatNode<'_, OT, H>> for Node
impl<OT, H> PartialOrd<FatNode<'_, OT, H>> for Node
Source§impl<N: PartialOrd, OT1, OT2, H1, H2> PartialOrd<FatNode<'_, OT1, H1, N>> for FatNode<'_, OT2, H2, N>
impl<N: PartialOrd, OT1, OT2, H1, H2> PartialOrd<FatNode<'_, OT1, H1, N>> for FatNode<'_, OT2, H2, N>
Source§impl<OT, H> PartialOrd<Node> for FatNode<'_, OT, H>
impl<OT, H> PartialOrd<Node> for FatNode<'_, OT, H>
impl<OT, H> Copy for FatNode<'_, OT, H>
impl<N: Eq, OT, H> Eq for FatNode<'_, OT, H, N>
Auto Trait Implementations§
impl<'hugr, OT, H, N> Freeze for FatNode<'hugr, OT, H, N>
impl<'hugr, OT, H, N> RefUnwindSafe for FatNode<'hugr, OT, H, N>
impl<'hugr, OT, H, N> Send for FatNode<'hugr, OT, H, N>
impl<'hugr, OT, H, N> Sync for FatNode<'hugr, OT, H, N>
impl<'hugr, OT, H, N> Unpin for FatNode<'hugr, OT, H, N>
impl<'hugr, OT, H, N> UnwindSafe for FatNode<'hugr, OT, H, N>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
, which can then be
downcast
into Box<dyn ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
, which can then be further
downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self
to use its Binary
implementation when Debug
-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self
to use its Display
implementation when
Debug
-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self
to use its LowerExp
implementation when
Debug
-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self
to use its LowerHex
implementation when
Debug
-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self
to use its Octal
implementation when Debug
-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self
to use its Pointer
implementation when
Debug
-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self
to use its UpperExp
implementation when
Debug
-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self
to use its UpperHex
implementation when
Debug
-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<N> NodeHandle<N> for Nwhere
N: HugrNode,
impl<N> NodeHandle<N> for Nwhere
N: HugrNode,
Source§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self
and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self
, then passes self.as_ref()
into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self
, then passes self.as_mut()
into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self
, then passes self.deref()
into the pipe function.Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B>
of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B>
of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R>
view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R>
view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target
of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap()
only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow()
only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref()
only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut()
only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref()
only in debug builds, and is erased in release
builds.