Versions in this module Expand all Collapse all v0 v0.4.0 Nov 6, 2026 v0.3.0 Nov 1, 2026 v0.2.0 Oct 24, 2026 v0.1.0 Oct 22, 2026 Changes in this version + var ErrAccessDenied = security.ErrDenied + var ErrDecode = code.ErrNoCompression + var ErrGraphvizFailed = errors.New("plantuml: Graphviz dot failed") + var ErrGraphvizNotFound = errors.New("plantuml: Graphviz dot not found") + var ErrGraphvizTimeout = errors.New("plantuml: Graphviz dot timed out") + var ErrNoDiagram = errors.New("plantuml: no diagram found") + var ErrSyntax = errors.New("plantuml: syntax error") + var ErrUnsupportedDiagram = errors.New("plantuml: diagram type not supported") + var ErrUnsupportedFormat = errors.New("plantuml: format not supported for this diagram") + func Decode(text string) (string, error) + func Encode(source string) string + type Block struct + Description string + Err error + Family string + Name string + Type string + func Inspect(ctx context.Context, source string, opts *Options) ([]*Block, error) + func (b *Block) Encoded() string + func (b *Block) Pages() int + func (b *Block) Render(ctx context.Context, w io.Writer, page int, opts *Options) (*Result, error) + func (b *Block) Source() []string + type Define struct + Name string + Value string + type Format int + const PNG + const SVG + const TXT + const UTXT + func (f Format) String() string + type Options struct + Config []string + DarkMode bool + Defines []Define + Diagram int + Dir string + DotPath string + DotTimeout time.Duration + FS fs.FS + Filename string + Format Format + IncludePaths []string + NoErrorImage bool + NoMetadata bool + Page int + SecurityProfile string + Theme string + type Result struct + Data []byte + Description string + Diagrams int + Height int + Pages int + Width int + func Render(ctx context.Context, source string, opts *Options) (*Result, error) + type SyntaxError struct + Line int + Message string + func (e *SyntaxError) Error() string + func (e *SyntaxError) Is(target error) bool + type UnsupportedError struct + Line int + Message string + func (e *UnsupportedError) Error() string + func (e *UnsupportedError) Is(target error) bool
Go to main page