moonrockz/diagrams-plantuml/json

moonrockz/diagrams-plantuml/json does not have a README file

Conversion

pub struct Conversion {
  tree : @moonrockz/diagrams/data-tree.DataTree
DataTree?
  diagnostics : ReadOnlyArray[@moonrockz/diagrams.Diagnostic
Diagnostic]
}

The result of converting a document to a data tree.

Document

source

pub struct Document {
  name : String?
  statements : ReadOnlyArray[@moonrockz/diagrams-plantuml/envelope.Statement
Statement]
  highlights : ReadOnlyArray[@moonrockz/diagrams-plantuml/data.Selector
Selector]
  value : Value
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One parsed JSON diagram block.

Document::equal

source

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

Document::logical_equal

source

fn Document::logical_equal(self : Document, other : Document) -> Bool

Compare two documents without spans and source spellings.

Document::new

source

fn Document::new(value : Value, name? : String, statements? : ArrayView[@moonrockz/diagrams-plantuml/envelope.Statement
Statement], highlights? : ArrayView[@moonrockz/diagrams-plantuml/data.Selector
Selector]) -> Document

A document. The constructor copies its arrays.

Document::not_equal

source

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

Document::to_repr

source

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

Member

source

pub struct Member {
  name : Str
  value : Value
  span : @moonrockz/diagrams.Span
Span?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One object member occurrence.

Member::equal

source

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

Member::new

source

fn Member::new(name : String, value : Value) -> Member

Member::not_equal

source

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

Member::to_repr

source

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

ReadResult

source

pub struct ReadResult {
  nodes : Array[@moonrockz/diagrams-plantuml/cst.Node
Node]
  document : Document?
  diagnostics : ReadOnlyArray[@moonrockz/diagrams.Diagnostic
Diagnostic]
}

The result of reading a JSON body.

Str

source

pub struct Str {
  text : String
  raw : String?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A JSON string. text is the decoded value. raw is the source spelling with its quotes, or None for a constructed value. Logical comparison and canonical writing use only text.

Str::equal

source

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

Str::new

source

fn Str::new(text : String) -> Str

Str::not_equal

source

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

Str::to_repr

source

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

Value

source

pub struct Value {
  kind : ValueKind
  span : @moonrockz/diagrams.Span
Span?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One JSON value with its source span.

Value::array

source

fn Value::array(items : ArrayView[Value]) -> Value

An array. The constructor copies items.

Value::boolean

source

fn Value::boolean(value : Bool) -> Value

Value::equal

source

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

Value::kind_name

source

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

The kind name of a value: object, array, string, number, boolean or null.

Value::logical_equal

source

fn Value::logical_equal(self : Value, other : Value) -> Bool

Compare two values without spans and source spellings. The comparison uses an explicit stack, so deep values do not use the call stack.

Value::not_equal

source

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

Value::null

source

fn Value::null() -> Value

Value::number

source

fn Value::number(lexeme : String) -> Value

A number with an exact decimal lexeme, for example -0.0 or 1e400. Writing gives an error when the lexeme is not a valid JSON number.

Value::object

source

fn Value::object(members : ArrayView[Member]) -> Value

An object. The constructor copies members.

Value::string

source

fn Value::string(text : String) -> Value

Value::to_repr

source

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

ValueKind

source

pub(all) enum ValueKind {
  Object(ReadOnlyArray[Member])
  Array(ReadOnlyArray[Value])
  String(Str)
  Number(String)
  Boolean(Bool)
  Null
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The kind and content of one JSON value.

ValueKind::equal

source

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

ValueKind::not_equal

source

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

ValueKind::to_repr

source

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

diagnostic_codes

source

let diagnostic_codes : ReadOnlyArray[String]

The stable diagnostic codes of the JSON reader, writer and converter.

print_body

source

fn print_body(document : Document, limits? : @moonrockz/diagrams-plantuml/envelope.Limits
Limits) -> Result[String, ReadOnlyArray[@moonrockz/diagrams.Diagnostic
Diagnostic]]

Write the canonical body of a JSON block: one #highlight line for each selector, then the value. Every line ends with a line break. The text has no block markers and no shared statements. On error there is no output.

print_value

source

fn print_value(value : Value, limits? : @moonrockz/diagrams-plantuml/envelope.Limits
Limits) -> Result[String, ReadOnlyArray[@moonrockz/diagrams.Diagnostic
Diagnostic]]

Write the canonical text of one value: two-space indentation, one member or element on each line, {} and [] for empty containers. The output has no trailing line break. Numbers keep their exact lexemes.

read

source

fn read(scan : @moonrockz/diagrams-plantuml/envelope.Scan
Scan, limits? : @moonrockz/diagrams-plantuml/envelope.Limits
Limits) -> ReadResult

Read the JSON body of a scanned block. The reader keeps every member occurrence in order, exact number lexemes and decoded strings with their spellings. It follows the pinned PlantUML profile: a // comment can stand only before a member name or after a member value; malformed input is refused with a diagnostic, never coerced.

to_data_tree

source

fn to_data_tree(document : Document, id? : String, limits? : @moonrockz/diagrams-plantuml/envelope.Limits
Limits) -> Conversion

Convert a JSON document to a structured-data model. Identities come from ordered ownership paths: the root value is v, member 2 of the value of root member 0 is m/0/2 and its value is v/0/2. Names and scalar text never define identity, so repeated members stay separate.

The model keeps a scalar root and empty root containers as they are. PlantUML 1.2026.9 draws a scalar root as a one-element array and an empty root container as an array with one empty string; this library does not copy that projection. The title is the last title statement.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#Conversion

#Document

#Document::equal

#Document::logical_equal

#Document::new

#Document::not_equal

#Document::to_repr

#Member

#Member::equal

#Member::new

#Member::not_equal

#Member::to_repr

#ReadResult

#Str

#Str::equal

#Str::new

#Str::not_equal

#Str::to_repr

#Value

#Value::array

#Value::boolean

#Value::equal

#Value::kind_name

#Value::logical_equal

#Value::not_equal

#Value::null

#Value::number

#Value::object

#Value::string

#Value::to_repr

#ValueKind

#ValueKind::equal

#ValueKind::not_equal

#ValueKind::to_repr

#diagnostic_codes

#print_body

#print_value

#read

#to_data_tree

Source Files

Conversion

Document

Document::equal

Document::logical_equal

Document::new

Document::not_equal

Document::to_repr

Member

Member::equal

Member::new

Member::not_equal

Member::to_repr

ReadResult

Str

Str::equal

Str::new

Str::not_equal

Str::to_repr

Value

Value::array

Value::boolean

Value::equal

Value::kind_name

Value::logical_equal

Value::not_equal

Value::null

Value::number

Value::object

Value::string

Value::to_repr

ValueKind

ValueKind::equal

ValueKind::not_equal

ValueKind::to_repr

diagnostic_codes

print_body

print_value

read

to_data_tree