Skip to main content

GraphBuilder

oximedia_graph::graph

Struct GraphBuilder 

Source 
pub struct GraphBuilder<State> { /* private fields */ }
Expand description

Builder for constructing filter graphs with type-state pattern.

The builder ensures that graphs are constructed correctly:

  1. Add nodes
  2. Connect nodes
  3. Build the graph

Implementations§

Source§

impl GraphBuilder<Empty>

Source

pub fn new() -> Self

Create a new graph builder.

Source

pub fn add_node(self, node: Box<dyn Node>) -> (GraphBuilder<HasNodes>, NodeId)

Add the first node to the graph.

Source§

impl GraphBuilder<HasNodes>

Source

pub fn add_node(self, node: Box<dyn Node>) -> (Self, NodeId)

Add another node to the graph.

Source

pub fn connect( self, from_node: NodeId, from_port: PortId, to_node: NodeId, to_port: PortId, ) -> GraphResult<GraphBuilder<HasConnections>>

Connect two nodes.

Source

pub fn build(self) -> GraphResult<FilterGraph>

Build the graph without any connections (single node graph).

Source§

impl GraphBuilder<HasConnections>

Source

pub fn add_node(self, node: Box<dyn Node>) -> (Self, NodeId)

Add another node to the graph.

Source

pub fn connect( self, from_node: NodeId, from_port: PortId, to_node: NodeId, to_port: PortId, ) -> GraphResult<Self>

Add another connection.

Source

pub fn build(self) -> GraphResult<FilterGraph>

Build the filter graph.

Trait Implementations§

Source§

impl Default for GraphBuilder<Empty>

Source§

fn default() -> Self

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

Auto Trait Implementations§

§

impl<State> !RefUnwindSafe for GraphBuilder<State>

§

impl<State> !UnwindSafe for GraphBuilder<State>

§

impl<State> Freeze for GraphBuilder<State>

§

impl<State> Send for GraphBuilder<State>
where State: Send,

§

impl<State> Sync for GraphBuilder<State>
where State: Sync,

§

impl<State> Unpin for GraphBuilder<State>
where State: Unpin,

§

impl<State> UnsafeUnpin for GraphBuilder<State>

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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.