Struct Schematic

Source
pub struct Schematic<DATA> { /* private fields */ }

Implementations§

Source§

impl<DATA> Schematic<DATA>
where DATA: Clone,

Source

pub fn new<T: Into<String>>( name: T, input_data: DATA, output_data: DATA, ) -> Self

Source

pub fn name(&self) -> &str

Source

pub fn input(&self) -> &Node<DATA>

Source

pub fn output(&self) -> &Node<DATA>

Source

pub fn inherent(&self) -> &Node<DATA>

Source

pub fn connections(&self) -> &[Connection<DATA>]

Source

pub fn get_port(&self, port: &PortReference) -> &NodePort

Source

pub fn get_ports(&self) -> Vec<PortReference>

Source

pub fn get_port_name(&self, port: &PortReference) -> &str

Source

pub fn add_input<T: Into<String>>(&mut self, port: T) -> PortReference

Source

pub fn add_output<T: Into<String>>(&mut self, port: T) -> PortReference

Source

pub fn nodes(&self) -> &[Node<DATA>]

Source

pub fn used_nodes(&self) -> Vec<&Node<DATA>>

Source

pub fn get(&self, index: NodeIndex) -> Option<&Node<DATA>>

Source

pub fn get_mut(&mut self, index: NodeIndex) -> Option<&mut Node<DATA>>

Source

pub fn find(&self, name: &str) -> Option<&Node<DATA>>

Source

pub fn find_mut(&mut self, name: &str) -> Option<&mut Node<DATA>>

Source

pub fn get_port_connections(&self, port: &NodePort) -> Vec<&Connection<DATA>>

Source

pub fn get_connections(&self) -> &[Connection<DATA>]

Source

pub fn downstreams_from( &self, node: NodeIndex, ) -> Option<Vec<Connections<'_, DATA>>>

Source

pub fn downstream_connections<T: AsRef<PortReference>>( &self, port: T, ) -> Option<Connections<'_, DATA>>

Source

pub fn upstreams_from( &self, node: NodeIndex, ) -> Option<Vec<Connections<'_, DATA>>>

Source

pub fn upstream_connections<T: AsRef<PortReference>>( &self, port: T, ) -> Option<Connections<'_, DATA>>

Source

pub fn add_external<T: Into<String>>( &mut self, name: T, reference: NodeReference, data: DATA, ) -> NodeIndex

Source

pub fn add_and_get_mut<T: Into<String>>( &mut self, name: T, reference: NodeReference, data: DATA, ) -> &mut Node<DATA>

Source

pub fn add_inherent<T: Into<String>>( &mut self, name: T, reference: NodeReference, data: DATA, ) -> NodeIndex

Source

pub fn connect( &mut self, from: PortReference, to: PortReference, data: DATA, ) -> Result<(), Error>

Source

pub fn walker(&self) -> SchematicWalker<'_, DATA>

Source

pub fn walk_from_output(&self) -> SchematicWalker<'_, DATA>

Source

pub fn walk_from_port<T: AsRef<PortReference>>( &self, port: T, direction: WalkDirection, ) -> SchematicWalker<'_, DATA>

Source

pub fn render_dot(&self) -> String

Trait Implementations§

Source§

impl<DATA: Clone> Clone for Schematic<DATA>

Source§

fn clone(&self) -> Schematic<DATA>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<DATA: Debug> Debug for Schematic<DATA>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<DATA> PartialEq for Schematic<DATA>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

Auto Trait Implementations§

§

impl<DATA> Freeze for Schematic<DATA>

§

impl<DATA> RefUnwindSafe for Schematic<DATA>
where DATA: RefUnwindSafe,

§

impl<DATA> Send for Schematic<DATA>
where DATA: Send,

§

impl<DATA> Sync for Schematic<DATA>
where DATA: Sync,

§

impl<DATA> Unpin for Schematic<DATA>
where DATA: Unpin,

§

impl<DATA> UnwindSafe for Schematic<DATA>
where DATA: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.