Graph

Struct Graph 

Source
pub struct Graph { /* private fields */ }
Expand description

A multichannel graph is a set of root nodes, one per output channel.

Implementations§

Source§

impl Graph

Source

pub fn new() -> Self

Creates an empty graph.

Source

pub fn render<R>(self, roots: R) -> Self
where R: Into<GraphRoots>,

Adds one or more output roots and returns the graph.

Source

pub fn root<R>(self, roots: R) -> Self
where R: Into<GraphRoots>,

Backward-compatible alias for render.

Source

pub fn with_root<R>(self, roots: R) -> Self
where R: Into<GraphRoots>,

Backward-compatible alias for render.

Source

pub fn mount(&self) -> Result<MountedGraph, MountError>

Lowers the graph and keeps mounted-node handles for direct updates.

Returns Err(MountError::DuplicateKey(...)) if two nodes in the graph share the same key prop.

Source

pub fn mount_with_id_counter( &self, next_id: &mut NodeId, ) -> Result<MountedGraph, MountError>

Lowers the graph using an external node-ID counter.

Each call advances next_id past all allocated IDs. This allows successive graph rebuilds to produce unique node IDs within the same runtime session, avoiding NodeAlreadyExists errors.

Returns Err(MountError::DuplicateKey(...)) if two nodes in the graph share the same key prop.

Source

pub fn push_root(&mut self, node: Node)

Adds one root node.

Source

pub fn roots(&self) -> &[Node]

Returns the graph roots.

Source

pub fn lower(&self) -> InstructionBatch

Lowers the graph into a runtime instruction batch.

Panics if the graph contains duplicate keyed nodes. Prefer [mount] for fallible access.

Trait Implementations§

Source§

impl Clone for Graph

Source§

fn clone(&self) -> Graph

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 Debug for Graph

Source§

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

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

impl Default for Graph

Source§

fn default() -> Graph

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Graph

§

impl RefUnwindSafe for Graph

§

impl Send for Graph

§

impl Sync for Graph

§

impl Unpin for Graph

§

impl UnwindSafe for Graph

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.