Skip to main content

GraphPartition

Struct GraphPartition 

Source
pub struct GraphPartition { /* private fields */ }
Available on crate feature distributed only.
Expand description

A single local partition wrapping a Graph plus its boundary ports.

GraphPartition is a thin convenience wrapper: it owns the local sub-graph and the boundary declaration, and delegates GraphPartition::compile and GraphPartition::process_cycle straight to the inner Graph. The RT-safety contract of Graph::process_cycle is therefore unchanged.

Implementations§

Source§

impl GraphPartition

Source

pub fn new(graph: Graph, boundary: Vec<BoundaryPort>) -> Self

Creates a new partition wrapping graph with the given boundary ports.

Source

pub fn compile(&mut self, config: GraphConfig) -> Result<(), GraphError>

Compiles the inner graph (delegates to Graph::compile).

§Errors

Returns GraphError::AlreadyCompiled if the graph was already compiled, or GraphError::CycleDetected if the topology contains a cycle.

Source

pub fn process_cycle( &mut self, ctx: &mut ProcessContext, ) -> Result<(), GraphError>

Processes one audio cycle on the inner graph (delegates to Graph::process_cycle).

§Errors

Returns GraphError::NotCompiled if the graph has not been compiled.

Source

pub fn boundary(&self) -> &[BoundaryPort]

Returns the boundary ports of this partition.

Source

pub fn graph(&self) -> &Graph

Returns a shared reference to the inner graph.

Source

pub fn graph_mut(&mut self) -> &mut Graph

Returns a mutable reference to the inner graph.

Auto Trait Implementations§

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> 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, 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.