render

package

Go to main page

Versions in this module

v0

v0.10.0

Oct 27, 2026

Changes in this version

type WalkthroughJSONRenderer

+ Transform func(*pidl.Walkthrough) error

+ func (r *WalkthroughJSONRenderer) Build(p *pidl.Protocol) (pidl.Walkthrough, error)

v0.9.0

Oct 22, 2026

Changes in this version

+ const PostmanSchema

+ const SignerNone

+ const SignerProxy

+ func ReadPostmanTargets(path string) (map[string]PostmanTarget, error)

type Format

+ const FormatPostman

+ const FormatPostmanEnvironment

+ type PostmanBody struct

+ Mode string

+ Options *PostmanRawOptions

+ Raw string

+ type PostmanCollection struct

+ Event []PostmanEvent

+ Info PostmanInfo

+ Item []PostmanItem

+ Variable []PostmanVariable

+ type PostmanEnvironment struct

+ ID string

+ Name string

+ Scope string

+ Values []PostmanEnvironmentValue

+ func NewPostmanEnvironment(p *pidl.Protocol, name string, t PostmanTarget) (*PostmanEnvironment, error)

+ func (e *PostmanEnvironment) JSON() (string, error)

+ type PostmanEnvironmentRenderer struct

+ Name string

+ Target *PostmanTarget

+ func (r *PostmanEnvironmentRenderer) Format() Format

+ func (r *PostmanEnvironmentRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *PostmanEnvironmentRenderer) RenderString(p *pidl.Protocol) (string, error)

+ type PostmanEnvironmentValue struct

+ Enabled bool

+ Key string

+ Type string

+ Value string

+ type PostmanEvent struct

+ Listen string

+ Script PostmanScript

+ type PostmanHeader struct

+ Key string

+ Value string

+ type PostmanInfo struct

+ Description string

+ Name string

+ PostmanID string

+ Schema string

+ type PostmanItem struct

+ Description string

+ Event []PostmanEvent

+ ID string

+ Item []PostmanItem

+ Name string

+ Request *PostmanRequest

+ Response []PostmanResponse

+ type PostmanOptions struct

+ Client string

+ Mock bool

+ PollLimit int

+ Signer string

+ type PostmanRawOptions struct

+ Raw struct{ ... }

+ type PostmanRenderer struct

+ Options PostmanOptions

+ func NewPostman(opts PostmanOptions) *PostmanRenderer

+ func (r *PostmanRenderer) Collection(p *pidl.Protocol) (*PostmanCollection, error)

+ func (r *PostmanRenderer) Format() Format

+ func (r *PostmanRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *PostmanRenderer) RenderString(p *pidl.Protocol) (string, error)

+ type PostmanRequest struct

+ Body *PostmanBody

+ Header []PostmanHeader

+ Method string

+ URL string

+ type PostmanResponse struct

+ Body string

+ Code int

+ Header []PostmanHeader

+ Name string

+ OriginalRequest *PostmanRequest

+ PreviewLanguage string

+ Status string

+ type PostmanScript struct

+ Exec []string

+ Type string

+ type PostmanTarget struct

+ Roles map[string]string

+ Scenarios map[string]map[string]string

+ Signer string

+ Variables map[string]string

+ type PostmanVariable struct

+ Key string

+ Value string

v0.8.0

Oct 20, 2026

Changes in this version

type Format

+ const FormatViewer

+ const FormatWalkthroughJSON

+ type ViewerRenderer struct

+ Walkthrough *WalkthroughJSONRenderer

+ func NewViewer() *ViewerRenderer

+ func (r *ViewerRenderer) Format() Format

+ func (r *ViewerRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *ViewerRenderer) RenderString(p *pidl.Protocol) (string, error)

+ type WalkthroughJSONRenderer struct

+ Analysis analyze.AnalysisOptions

+ Analyze bool

+ func NewWalkthroughJSON() *WalkthroughJSONRenderer

+ func (r *WalkthroughJSONRenderer) Format() Format

+ func (r *WalkthroughJSONRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *WalkthroughJSONRenderer) RenderString(p *pidl.Protocol) (string, error)

+ func (r *WalkthroughJSONRenderer) Walkthrough(p *pidl.Protocol) pidl.Walkthrough

v0.7.0

Oct 19, 2026

Changes in this version

+ func IsDocumentFormat(format Format) bool

+ func SupportsIncludes(format Format) bool

type Format

+ const FormatOutline

+ const FormatOutlineJSON

+ const FormatScenarioMatrix

+ const FormatTokenTable

+ type OutlineJSONRenderer struct

+ func NewOutlineJSON() *OutlineJSONRenderer

+ func (r *OutlineJSONRenderer) Format() Format

+ func (r *OutlineJSONRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *OutlineJSONRenderer) RenderString(p *pidl.Protocol) (string, error)

+ type OutlineRenderer struct

+ func NewOutline() *OutlineRenderer

+ func (r *OutlineRenderer) Format() Format

+ func (r *OutlineRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *OutlineRenderer) RenderString(p *pidl.Protocol) (string, error)

+ type ScenarioMatrixRenderer struct

+ IncludeFragments bool

+ Title bool

+ func NewScenarioMatrix() *ScenarioMatrixRenderer

+ func (r *ScenarioMatrixRenderer) Format() Format

+ func (r *ScenarioMatrixRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *ScenarioMatrixRenderer) RenderString(p *pidl.Protocol) (string, error)

+ type TokenTableRenderer struct

+ Title bool

+ func NewTokenTable() *TokenTableRenderer

+ func (r *TokenTableRenderer) Format() Format

+ func (r *TokenTableRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *TokenTableRenderer) RenderString(p *pidl.Protocol) (string, error)

v0.6.0

Sep 13, 2026

Changes in this version

type SequenceRenderOptions

+ ShowVerification bool

v0.5.0

Jul 12, 2026

Changes in this version

type D2Renderer

+ ShowStepTypes bool

type Format

+ const FormatInfographic

+ type InfographicOptions struct

+ AnimateDots bool

+ BidirectionalDots bool

+ Direction string

+ DotSpeed float64

+ DotsPerEdge int

+ FontSize int

+ Height int

+ MaxNodes int

+ NodeRadius int

+ Padding int

+ ShowEdgeLabels bool

+ ShowLabels bool

+ Size InfographicSize

+ StrokeWidth int

+ Theme InfographicTheme

+ Title string

+ TitleFontSize int

+ TruncateLabels int

+ UseCustomShapes bool

+ Width int

+ func DatasheetTileOptions() InfographicOptions

+ func DefaultInfographicOptions() InfographicOptions

+ type InfographicRenderer struct

+ func NewInfographicRenderer(opts InfographicOptions) *InfographicRenderer

+ func (r *InfographicRenderer) Render(p *pidl.Protocol) string

+ type InfographicSize string

+ const SizeDatasheetTile

+ const SizeDatasheetWide

+ const SizeLinkedInLandscape

+ const SizeLinkedInPortrait

+ const SizeLinkedInSquare

+ type InfographicTheme string

+ const ThemeAccessible

+ const ThemeBold

+ const ThemeCorporate

+ const ThemeDark

+ const ThemeMinimal

+ const ThemeTech

type MermaidRenderer

+ ShowStepTypes bool

+ type NodeShape string

+ const ShapeCircle

+ const ShapeCloud

+ const ShapeCylinder

+ const ShapeDiamond

+ const ShapeHexagon

+ const ShapeRectangle

type PlantUMLRenderer

+ ShowStepTypes bool

type SVGRenderer

+ ShowStepTypes bool

type SequenceRenderOptions

+ ShowDataPorts bool

v0.4.0

Jun 29, 2026

Changes in this version

type Format

+ const FormatMarkdownMatrix

+ const FormatMermaidComponent

+ const FormatMermaidState

+ const FormatMermaidTrust

+ const FormatSVGComponent

+ const FormatSVGTrust

+ type MarkdownMatrixRenderer struct

+ ShowDescription bool

+ Title bool

+ func NewMarkdownMatrix() *MarkdownMatrixRenderer

+ func (r *MarkdownMatrixRenderer) Format() Format

+ func (r *MarkdownMatrixRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *MarkdownMatrixRenderer) RenderString(p *pidl.Protocol) (string, error)

+ type MermaidComponentRenderer struct

+ ShowEntities bool

+ ShowRoles bool

+ Title bool

+ func NewMermaidComponent() *MermaidComponentRenderer

+ func (r *MermaidComponentRenderer) Format() Format

+ func (r *MermaidComponentRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *MermaidComponentRenderer) RenderString(p *pidl.Protocol) (string, error)

+ type MermaidStateRenderer struct

+ EntityFilter string

+ ShowDescriptions bool

+ Title bool

+ func NewMermaidState() *MermaidStateRenderer

+ func (r *MermaidStateRenderer) Format() Format

+ func (r *MermaidStateRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *MermaidStateRenderer) RenderString(p *pidl.Protocol) (string, error)

+ type MermaidTrustRenderer struct

+ ShowComponents bool

+ ShowCredentials bool

+ Title bool

+ func NewMermaidTrust() *MermaidTrustRenderer

+ func (r *MermaidTrustRenderer) Format() Format

+ func (r *MermaidTrustRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *MermaidTrustRenderer) RenderString(p *pidl.Protocol) (string, error)

+ type SVGComponentRenderer struct

+ ShowEntities bool

+ ShowRoles bool

+ Theme string

+ Title bool

+ func NewSVGComponent() *SVGComponentRenderer

+ func (r *SVGComponentRenderer) Format() Format

+ func (r *SVGComponentRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *SVGComponentRenderer) RenderString(p *pidl.Protocol) (string, error)

type SVGNetworkRenderer

+ InferBoundariesFromTrust bool

+ ShowTrust bool

type SVGRenderer

+ ShowPhases bool

+ type SVGTrustRenderer struct

+ ShowComponents bool

+ ShowCredentials bool

+ Theme string

+ Title bool

+ func NewSVGTrust() *SVGTrustRenderer

+ func (r *SVGTrustRenderer) Format() Format

+ func (r *SVGTrustRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *SVGTrustRenderer) RenderString(p *pidl.Protocol) (string, error)

+ type SequenceRenderOptions struct

+ ShowAlternatives bool

+ ShowAnnotations bool

+ ShowConditions bool

+ ShowNotes bool

+ ShowSecurity bool

+ Title bool

+ func DefaultSequenceRenderOptions() SequenceRenderOptions

+ type TraceRenderer struct

+ HighlightSkipped bool

+ ShowStates bool

+ ShowTimings bool

+ func NewTraceRenderer() *TraceRenderer

+ func (r *TraceRenderer) Render(w io.Writer, trace *pidl.ExecutionTrace, opts TraceTextOptions) error

+ func (r *TraceRenderer) RenderJSON(trace *pidl.ExecutionTrace) ([]byte, error)

+ func (r *TraceRenderer) RenderMermaid(trace *pidl.ExecutionTrace, p *pidl.Protocol) string

+ func (r *TraceRenderer) RenderSVG(trace *pidl.ExecutionTrace, p *pidl.Protocol) (string, error)

+ func (r *TraceRenderer) RenderText(trace *pidl.ExecutionTrace, opts TraceTextOptions) string

+ type TraceRendererInterface interface

+ RenderMermaid func(trace *pidl.ExecutionTrace, p *pidl.Protocol) string

+ RenderSVG func(trace *pidl.ExecutionTrace, p *pidl.Protocol) (string, error)

+ RenderText func(trace *pidl.ExecutionTrace, opts TraceTextOptions) string

+ type TraceTextOptions struct

+ Compact bool

+ ShowStates bool

+ ShowTimestamps bool

+ UseColors bool

+ func DefaultTraceTextOptions() TraceTextOptions

v0.3.0

May 18, 2026

Changes in this version

type Format

+ const FormatSVG

+ const FormatSVGAnimated

+ const FormatSVGNetwork

+ type SVGNetworkRenderer struct

+ Animated bool

+ BoundaryOverrides map[string][]string

+ Direction string

+ Theme string

+ Title bool

+ func NewSVGNetwork() *SVGNetworkRenderer

+ func (r *SVGNetworkRenderer) AddBoundaryOverride(boundaryID string, entityIDs []string)

+ func (r *SVGNetworkRenderer) Format() Format

+ func (r *SVGNetworkRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *SVGNetworkRenderer) RenderString(p *pidl.Protocol) (string, error)

+ type SVGRenderer struct

+ Animated bool

+ AnimationConfig svg.AnimationConfig

+ MessageSpacing int

+ ParticipantSpacing int

+ ShowNotes bool

+ ShowStepNumbers bool

+ Template string

+ TemplateDir string

+ Theme string

+ Title bool

+ func NewSVG() *SVGRenderer

+ func NewSVGAnimated() *SVGRenderer

+ func NewSVGWithTemplate(templateName string) (*SVGRenderer, error)

+ func NewSVGWithTemplateDir(dir string) (*SVGRenderer, error)

+ func (r *SVGRenderer) Format() Format

+ func (r *SVGRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *SVGRenderer) RenderString(p *pidl.Protocol) (string, error)

v0.2.0

Apr 19, 2026

Changes in this version

+ type D2Renderer struct

+ Direction string

+ ShowAlternatives bool

+ ShowAnnotations bool

+ ShowConditions bool

+ ShowDescriptions bool

+ ShowNotes bool

+ Style D2Style

+ Title bool

+ func NewD2() *D2Renderer

+ func NewD2Arch() *D2Renderer

+ func NewD2Flow() *D2Renderer

+ func (r *D2Renderer) Format() Format

+ func (r *D2Renderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *D2Renderer) RenderString(p *pidl.Protocol) (string, error)

+ type D2Style string

+ const D2StyleArch

+ const D2StyleFlow

+ const D2StyleSequence

type DOTRenderer

+ ShowAnnotations bool

+ ShowConditions bool

type Format

+ const FormatD2

+ const FormatD2Arch

+ const FormatD2Flow

type MermaidRenderer

+ ShowAlternatives bool

+ ShowAnnotations bool

+ ShowConditions bool

+ ShowNotes bool

type PlantUMLRenderer

+ ShowAlternatives bool

+ ShowAnnotations bool

+ ShowConditions bool

+ ShowNotes bool

v0.1.0

Apr 19, 2026

Changes in this version

+ func RenderString(format Format, p *pidl.Protocol) (string, error)

+ type DOTRenderer struct

+ MergeEdges bool

+ RankDir string

+ ShowPhases bool

+ Title bool

+ func NewDOT() *DOTRenderer

+ func (r *DOTRenderer) Format() Format

+ func (r *DOTRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *DOTRenderer) RenderString(p *pidl.Protocol) (string, error)

+ type Format string

+ const FormatDOT

+ const FormatMermaid

+ const FormatPlantUML

+ func MustParseFormat(s string) Format

+ func ParseFormat(s string) (Format, error)

+ func SupportedFormats() []Format

+ func (f Format) FileExtension() string

+ func (f Format) String() string

+ type MermaidRenderer struct

+ Autonumber bool

+ Title bool

+ func NewMermaid() *MermaidRenderer

+ func (r *MermaidRenderer) Format() Format

+ func (r *MermaidRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *MermaidRenderer) RenderString(p *pidl.Protocol) (string, error)

+ type PlantUMLRenderer struct

+ ShowDescriptions bool

+ Title bool

+ func NewPlantUML() *PlantUMLRenderer

+ func (r *PlantUMLRenderer) Format() Format

+ func (r *PlantUMLRenderer) Render(w io.Writer, p *pidl.Protocol) error

+ func (r *PlantUMLRenderer) RenderString(p *pidl.Protocol) (string, error)

+ type Renderer interface

+ Format func() Format

+ Render func(w io.Writer, p *pidl.Protocol) error

+ RenderString func(p *pidl.Protocol) (string, error)

+ func MustNew(format Format) Renderer

+ func New(format Format) (Renderer, error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL