Skip to main content

Graph

Struct Graph 

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

Graph is dagrs’s main body.

[‘Graph’] is a network that satisfies FBP logic, provides node dependencies, and runs all of its nodes completely asynchronously A Graph contains multiple nodes, which can be added as long as they implement the Node trait. Each node defines specific execution logic by implementing the [Action] trait and overriding the run method.

The execution process of a Graph proceeds as follows:

  • The user creates a set of nodes, each implementing the Node trait. These nodes can be created programmatically or Generate auto_node using parse.
  • Dependencies between nodes are defined, creating a directed acyclic graph (DAG) structure.
  • During execution, nodes communicate via input/output channels (InChannel and OutChannel). These channels support both point-to-point communication (using MPSC) and broadcasting (using Broadcast).
  • After all nodes complete their execution, marking the graph as inactive. This ensures that the Graph cannot be executed again without resetting its state.

The Graph is designed to efficiently manage task execution with built-in fault tolerance and flexible scheduling.

Implementations§

Source§

impl Graph

Source

pub fn new() -> Graph

Constructs a new Graph

Source

pub fn reset(&mut self)

Reset the graph state but keep the nodes.

Source

pub fn add_node(&mut self, node: impl Node + 'static)

Adds a new node to the Graph

Source

pub fn add_edge(&mut self, from_id: NodeId, all_to_ids: Vec<NodeId>)

Adds an edge between two nodes in the Graph. If the outgoing port of the sending node is empty and the number of receiving nodes is > 1, use the broadcast channel An MPSC channel is used if the outgoing port of the sending node is empty and the number of receiving nodes is equal to 1 If the outgoing port of the sending node is not empty, adding any number of receiving nodes will change all relevant channels to broadcast

Source

pub fn start(&mut self) -> Result<(), GraphError>

This function is used for the execution of a single dag.

Source

pub fn check_loop_and_partition(&mut self) -> bool

Checks for cycles in the abstract graph, and partitions the graph into blocks.

  • Groups nodes into blocks, creating a new block whenever a conditional node / loop is encountered

Returns true if the graph contains a cycle, false otherwise.

Source

pub fn get_results<T>(&self) -> HashMap<NodeId, Option<Arc<T>>>
where T: Send + Sync + 'static,

Get the output of all tasks.

Source

pub fn get_outputs(&self) -> HashMap<NodeId, Output>

Source

pub fn set_env(&mut self, env: EnvVar)

Before the dag starts executing, set the dag’s global environment variable.

Auto Trait Implementations§

§

impl !RefUnwindSafe for Graph

§

impl !UnwindSafe for Graph

§

impl Freeze for Graph

§

impl Send for Graph

§

impl Sync for Graph

§

impl Unpin for Graph

§

impl UnsafeUnpin 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> MaybeSendSync for T
where T: Send + Sync,

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more