Skip to main content

GraphBuilder

Struct GraphBuilder 

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

Mutable construction API. build freezes nodes into immutable graph.

Implementations§

Source§

impl GraphBuilder

Source

pub const fn new() -> Self

Creates empty graph builder.

Source

pub fn source(&mut self, name: impl Into<String>, media: ClipMedia) -> Clip

Adds source node and returns immutable clip handle.

Source

pub fn source_with_request( &mut self, request: SourceRequest, media: ClipMedia, ) -> Clip

Adds source node with explicit request metadata.

Source

pub fn source_with_capabilities( &mut self, name: impl Into<String>, media: ClipMedia, capabilities: SourceCapabilities, ) -> Clip

Adds source node with explicit scheduler capabilities.

Source

pub fn source_with_request_and_capabilities( &mut self, request: SourceRequest, media: ClipMedia, capabilities: SourceCapabilities, ) -> Clip

Adds source node with explicit request metadata and scheduler capabilities.

Source

pub fn filter( &mut self, name: impl Into<String>, inputs: &[Clip], media: ClipMedia, compatibility: FilterCompatibility, ) -> Result<Clip>

Adds filter node and returns new immutable clip handle.

Source

pub fn filter_with_schedule( &mut self, name: impl Into<String>, inputs: &[Clip], media: ClipMedia, compatibility: FilterCompatibility, dependencies: DependencyPattern, concurrency: ConcurrencyClass, ) -> Result<Clip>

Adds filter node with explicit scheduling contract.

Source

pub fn filter_with_schedule_and_options( &mut self, name: impl Into<String>, inputs: &[Clip], media: ClipMedia, compatibility: FilterCompatibility, dependencies: DependencyPattern, concurrency: ConcurrencyClass, options: FilterOptions, ) -> Result<Clip>

Adds filter node with explicit scheduling contract and stored options.

Source

pub fn set_output(&mut self, output: Clip)

Replaces final output list with one clip.

Source

pub fn add_output(&mut self, output: Clip)

Adds final output clip. Phase 1 validation rejects multiple outputs.

Source

pub fn build(self) -> Graph

Freezes builder into immutable graph.

Trait Implementations§

Source§

impl Clone for GraphBuilder

Source§

fn clone(&self) -> GraphBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for GraphBuilder

Source§

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

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

impl Default for GraphBuilder

Source§

fn default() -> GraphBuilder

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

impl PartialEq for GraphBuilder

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · 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.
Source§

impl StructuralPartialEq for GraphBuilder

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