GraphApi

Struct GraphApi 

Source
pub struct GraphApi<'a> { /* private fields */ }
Expand description

Graph generation API for built flows

Implementations§

Source§

impl<'a> GraphApi<'a>

Source

pub fn new( ir: &'a [HydroRoot], process_id_name: &'a [(usize, String)], cluster_id_name: &'a [(usize, String)], external_id_name: &'a [(usize, String)], ) -> Self

Source

pub fn mermaid_to_string( &self, show_metadata: bool, show_location_groups: bool, use_short_labels: bool, ) -> String

Generate mermaid graph as string

Source

pub fn dot_to_string( &self, show_metadata: bool, show_location_groups: bool, use_short_labels: bool, ) -> String

Generate DOT graph as string

Source

pub fn reactflow_to_string( &self, show_metadata: bool, show_location_groups: bool, use_short_labels: bool, ) -> String

Generate ReactFlow graph as string

Source

pub fn mermaid_to_file( &self, filename: &str, show_metadata: bool, show_location_groups: bool, use_short_labels: bool, ) -> Result<(), Box<dyn Error>>

Write mermaid graph to file

Source

pub fn dot_to_file( &self, filename: &str, show_metadata: bool, show_location_groups: bool, use_short_labels: bool, ) -> Result<(), Box<dyn Error>>

Write DOT graph to file

Source

pub fn reactflow_to_file( &self, filename: &str, show_metadata: bool, show_location_groups: bool, use_short_labels: bool, ) -> Result<(), Box<dyn Error>>

Write ReactFlow graph to file

Source

pub fn mermaid_to_browser( &self, show_metadata: bool, show_location_groups: bool, use_short_labels: bool, message_handler: Option<&dyn Fn(&str)>, ) -> Result<(), Box<dyn Error>>

Open mermaid graph in browser

Source

pub fn dot_to_browser( &self, show_metadata: bool, show_location_groups: bool, use_short_labels: bool, message_handler: Option<&dyn Fn(&str)>, ) -> Result<(), Box<dyn Error>>

Open DOT graph in browser

Source

pub fn reactflow_to_browser( &self, show_metadata: bool, show_location_groups: bool, use_short_labels: bool, message_handler: Option<&dyn Fn(&str)>, ) -> Result<(), Box<dyn Error>>

Open ReactFlow graph in browser

Source

pub fn generate_all_files( &self, prefix: &str, show_metadata: bool, show_location_groups: bool, use_short_labels: bool, ) -> Result<(), Box<dyn Error>>

Generate all graph types and save to files with a given prefix

Source

pub fn generate_graph_with_config( &self, config: &GraphConfig, message_handler: Option<&dyn Fn(&str)>, ) -> Result<(), Box<dyn Error>>

Generate graph based on GraphConfig, delegating to the appropriate method

Source

pub fn generate_all_files_with_config( &self, config: &GraphConfig, prefix: &str, ) -> Result<(), Box<dyn Error>>

Generate all graph files based on GraphConfig

Auto Trait Implementations§

§

impl<'a> Freeze for GraphApi<'a>

§

impl<'a> !RefUnwindSafe for GraphApi<'a>

§

impl<'a> !Send for GraphApi<'a>

§

impl<'a> !Sync for GraphApi<'a>

§

impl<'a> Unpin for GraphApi<'a>

§

impl<'a> !UnwindSafe for GraphApi<'a>

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.

§

impl<T> Instrument for T

§

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

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

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

Source§

type Min = T

The weaker of the two orderings.
Source§

impl<T> MinRetries<T> for T

Source§

type Min = T

The weaker of the two retry guarantees.
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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> Same for T

Source§

type Output = T

Should always be Self
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.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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