Struct MermaidFormatter

pub struct MermaidFormatter<'h, H: HugrInternals + ?Sized = Hugr> { /* private fields */ }

Configuration for rendering a HUGR graph.

Implementations

impl<'h, H: HugrInternals + ?Sized> MermaidFormatter<'h, H>

pub fn from_render_config(config: RenderConfig<H::Node>, hugr: &'h H) -> Self

Create a new MermaidFormatter from a RenderConfig.

pub fn new(hugr: &'h H) -> Self

Create a new MermaidFormatter for the given Hugr.

pub fn entrypoint(&self) -> Option<H::Node>

The entrypoint to highlight in the rendered graph.

pub fn node_labels(&self) -> &NodeLabel<H::Node>

The rendering style of the node labels.

pub fn port_offsets(&self) -> bool

Whether to show port offsets on edges.

pub fn type_labels(&self) -> bool

Whether to show type labels on edges.

pub fn with_node_labels(self, node_labels: NodeLabel<H::Node>) -> Self

Set the node labels style.

pub fn with_port_offsets(self, show: bool) -> Self

Set whether to show port offsets in edges.

pub fn with_type_labels(self, show: bool) -> Self

Set whether to show type labels in edges.

pub fn with_entrypoint(self, entrypoint: impl Into<Option<H::Node>>) -> Self

Set the entrypoint node to highlight.

pub fn finish(self) -> String

where H: HugrView,

Render the graph into a Mermaid string.

Trait Implementations

impl<'h, H: Clone + HugrInternals + ?Sized> Clone for MermaidFormatter<'h, H>

where H::Node: Clone,

fn clone(&self) -> MermaidFormatter<'h, H>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'h, H: Debug + HugrInternals + ?Sized> Debug for MermaidFormatter<'h, H>

where H::Node: Debug,

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

Formats the value using the given formatter.

impl<'h, 'hh, H: HugrView> From<MermaidFormatter<'h, &'hh H>> for MermaidFormatter<'h, H>

fn from(value: MermaidFormatter<'h, &'hh H>) -> Self

Converts to this type from the input type.

impl<'h, 'hh, H: HugrView> From<MermaidFormatter<'h, &'hh mut H>> for MermaidFormatter<'h, H>

fn from(value: MermaidFormatter<'h, &'hh mut H>) -> Self

Converts to this type from the input type.

impl<'h, H: HugrView> From<MermaidFormatter<'h, Arc<H>>> for MermaidFormatter<'h, H>

fn from(value: MermaidFormatter<'h, Arc<H>>) -> Self

Converts to this type from the input type.

impl<'h, H: HugrView> From<MermaidFormatter<'h, Box<H>>> for MermaidFormatter<'h, H>

fn from(value: MermaidFormatter<'h, Box<H>>) -> Self

Converts to this type from the input type.

impl<'h, H: HugrView + ToOwned> From<MermaidFormatter<'h, Cow<'_, H>>> for MermaidFormatter<'h, H>

fn from(value: MermaidFormatter<'h, Cow<'_, H>>) -> Self

Converts to this type from the input type.

impl<'h, H: HugrView> From<MermaidFormatter<'h, Rc<H>>> for MermaidFormatter<'h, H>

fn from(value: MermaidFormatter<'h, Rc<H>>) -> Self

Converts to this type from the input type.

impl<'h, H: PartialEq + HugrInternals + ?Sized> PartialEq for MermaidFormatter<'h, H>

where H::Node: PartialEq,

fn eq(&self, other: &MermaidFormatter<'h, H>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'h, H: HugrInternals + ?Sized> TryFrom<MermaidFormatter<'h, H>> for RenderConfig<H::Node>

type Error = UnsupportedRenderConfig

The type returned in the event of a conversion error.

fn try_from(value: MermaidFormatter<'h, H>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'h, H: Eq + HugrInternals + ?Sized> Eq for MermaidFormatter<'h, H>

where H::Node: Eq,

impl<'h, H: HugrInternals + ?Sized> StructuralPartialEq for MermaidFormatter<'h, H>