GenAI.Graph.MermaidProtocol protocol (GenAI Core v0.3.1)

Copy Markdown

Mermaid Encode Protocol.

Summary

Types

t()

All the types that implement this protocol.

Functions

Convert element to mermaid output.

Convert element to mermaid output.

Convert element to mermaid output.

Format an ID for use in a Mermaid diagram.

Types

t()

@type t() :: term()

All the types that implement this protocol.

Functions

encode(graph_element)

@spec encode(term()) :: {:ok, term()} | {:error, term()}

Convert element to mermaid output.

encode(graph_element, options)

@spec encode(term(), term()) :: {:ok, term()} | {:error, term()}

Convert element to mermaid output.

encode(graph_element, options, state)

@spec encode(term(), term(), term()) :: {:ok, term()} | {:error, term()}

Convert element to mermaid output.

mermaid_id(id)

@spec mermaid_id(term()) :: term()

Format an ID for use in a Mermaid diagram.