moonrockz/diagrams/render

moonrockz/diagrams/render does not have a README file

Renderer

pub(open) trait Renderer {
  fn render(Self, Diagram) -> Rendered
}

Turns a diagram into output text, such as SVG.

Diagram

source

pub(all) enum Diagram {
  Sequence(@moonrockz/diagrams/sequence.Sequence
Sequence)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A diagram of one kind. Each kind has its own format-independent model.

Diagram::equal

source

fn Diagram::equal(Diagram, Diagram) -> Bool

Diagram::kind_name

source

fn Diagram::kind_name(self : Diagram) -> String

The name of the kind of diagram, for example sequence.

Diagram::not_equal

source

fn Diagram::not_equal(x : Diagram, y : Diagram) -> Bool

Diagram::to_repr

source

fn Diagram::to_repr(Diagram) -> @moonbitlang/core/debug.Repr
Repr

Rendered

source

pub struct Rendered {
  output : String?
  media_type : String
  diagnostics : ReadOnlyArray[@moonrockz/diagrams.Diagnostic
Diagnostic]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The result of a renderer. output is absent when the renderer cannot render the diagram; diagnostics then has an error.

Rendered::equal

source

fn Rendered::equal(Rendered, Rendered) -> Bool

Rendered::failed

source

fn Rendered::failed(media_type : String, diagnostics : ArrayView[@moonrockz/diagrams.Diagnostic
Diagnostic]) -> Rendered

A result with no output, for a diagram that could not be rendered. diagnostics says why.

Rendered::not_equal

source

fn Rendered::not_equal(x : Rendered, y : Rendered) -> Bool

Rendered::ok

source

fn Rendered::ok(output : String, media_type : String, diagnostics? : ArrayView[@moonrockz/diagrams.Diagnostic
Diagnostic]) -> Rendered

A result with output.

Rendered::to_repr

source

fn Rendered::to_repr(Rendered) -> @moonbitlang/core/debug.Repr
Repr

Rendered::unsupported

source

fn Rendered::unsupported(media_type : String, diagram : Diagram) -> Rendered

The result of a renderer that does not support the kind of diagram.

Source Files

render.mbt

Site source Report issue Packages Build queue Skills Statistics

#Renderer

#Diagram

#Diagram::equal

#Diagram::kind_name

#Diagram::not_equal

#Diagram::to_repr

#Rendered

#Rendered::equal

#Rendered::failed

#Rendered::not_equal

#Rendered::ok

#Rendered::to_repr

#Rendered::unsupported

Source Files

Renderer

Diagram

Diagram::equal

Diagram::kind_name

Diagram::not_equal

Diagram::to_repr

Rendered

Rendered::equal

Rendered::failed

Rendered::not_equal

Rendered::ok

Rendered::to_repr

Rendered::unsupported