moonrockz/diagrams/data-tree

README
- ::equalDiagnostic::equal
- ::errorDiagnostic::error
- ::not_equalDiagnostic::not_equal
- ::to_reprDiagnostic::to_repr
- ::warningDiagnostic::warning
- ::equalPosition::equal
- ::not_equalPosition::not_equal
- ::to_reprPosition::to_repr
- ::equalSeverity::equal
- ::not_equalSeverity::not_equal
- ::to_reprSeverity::to_repr
- ::equalSpan::equal
- ::not_equalSpan::not_equal
- ::to_reprSpan::to_repr
V
version

moonrockz/diagrams/data-tree does not have a README file

DataTree

pub struct DataTree {
  id : String
  root : String
  nodes : ReadOnlyArray[Node]
  highlights : ReadOnlyArray[Highlight]
  title : String?
  accessibility_title : String?
  accessibility_description : String?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One immutable structured-data diagram. It does not depend on JSON or YAML.

DataTree::equal

source

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

DataTree::new

source

fn DataTree::new(id : String, root : String, nodes : ArrayView[Node], highlights? : ArrayView[Highlight], title? : String, accessibility_title? : String, accessibility_description? : String) -> DataTree

DataTree::not_equal

source

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

DataTree::to_repr

source

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

Highlight

source

pub struct Highlight {
  targets : ReadOnlyArray[String]
  style : String?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

A view highlight. Targets are member or node identities. The optional style is inert author metadata; library themes paint every highlight.

Highlight::equal

source

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

Highlight::new

source

fn Highlight::new(targets : ArrayView[String], style? : String) -> Highlight

Highlight::not_equal

source

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

Highlight::to_repr

source

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

Index

source

pub struct Index {
  tree : DataTree
  order : ReadOnlyArray[String]
  // private fields
}

A validated data tree with constant-time lookups. Each node except the root has exactly one owning entry occurrence.

Index::build

source

fn Index::build(tree : DataTree, limits? : Limits) -> IndexResult

Validate identities, containment, keys, numbers, highlights and limits without recursion. Scalar text is never interpreted as a reference.

Index::container

source

fn Index::container(self : Index, entry : String) -> String?

The container node that holds a entry occurrence.

Index::depth

source

fn Index::depth(self : Index, node : String) -> Int?

Index::find_member

source

fn Index::find_member(self : Index, id : String) -> Member?

Index::node

source

fn Index::node(self : Index, id : String) -> Node?

Index::owner

source

fn Index::owner(self : Index, node : String) -> Member?

The entry occurrence that owns a node. The root has none.

IndexResult

source

pub struct IndexResult {
  index : Index?
  diagnostics : ReadOnlyArray[@moonrockz/diagrams.Diagnostic
Diagnostic]
}

Key

source

pub(all) enum Key {
  Name(String)
  Index(Int)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

The key of one member occurrence: an object member name or an array position.

Key::equal

source

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

Key::not_equal

source

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

Key::to_repr

source

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

Limits

source

pub struct Limits {
  nodes : Int
  depth : Int
  work : Int
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Explicit bounds for data-tree validation and indexing.

Limits::equal

source

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

Limits::new

source

fn Limits::new(nodes? : Int, depth? : Int, work? : Int) -> Limits

Limits::not_equal

source

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

Limits::to_repr

source

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

Member

source

pub struct Member {
  id : String
  key : Key
  value : String
  source : @moonrockz/diagrams.Span
Span?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

One member occurrence of a container. value names the child node. Repeated names and equal values keep separate member identities.

Member::equal

source

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

Member::index

source

fn Member::index(id : String, index : Int, value : String, source? : @moonrockz/diagrams.Span
Span) -> Member

Member::named

source

fn Member::named(id : String, name : String, value : String, source? : @moonrockz/diagrams.Span
Span) -> 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

Node

source

pub struct Node {
  id : String
  value : Value
  source : @moonrockz/diagrams.Span
Span?
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Node::array

source

fn Node::array(id : String, members : ArrayView[Member], source? : @moonrockz/diagrams.Span
Span) -> Node

Node::equal

source

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

Node::is_container

source

fn Node::is_container(self : Node) -> Bool

Node::members

source

fn Node::members(self : Node) -> ReadOnlyArray[Member]

The member occurrences of a container, or an empty array for a scalar.

Node::new

source

fn Node::new(id : String, value : Value, source? : @moonrockz/diagrams.Span
Span) -> Node

Node::not_equal

source

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

Node::object

source

fn Node::object(id : String, members : ArrayView[Member], source? : @moonrockz/diagrams.Span
Span) -> Node

Node::to_repr

source

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

Value

source

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

A typed value. Numbers keep their exact decimal lexeme; no machine floating-point value is computed.

Value::equal

source

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

Value::not_equal

source

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

Value::scalar_text

source

fn Value::scalar_text(self : Value) -> String?

The visible text of a scalar value, or None for a container.

Value::to_repr

source

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

diagnostic_codes

source

let diagnostic_codes : ReadOnlyArray[String]

The stable diagnostic codes of data-tree validation.

valid_number

source

fn valid_number(lexeme : String) -> Bool

True when lexeme is a valid JSON number spelling.

validate

source

fn validate(tree : DataTree, limits? : Limits) -> ReadOnlyArray[@moonrockz/diagrams.Diagnostic
Diagnostic]

Validate a constructed data tree. An empty result means the tree is valid.

Source Files

Site source Report issue Packages Build queue Skills Statistics

#DataTree

#DataTree::equal

#DataTree::new

#DataTree::not_equal

#DataTree::to_repr

#Highlight

#Highlight::equal

#Highlight::new

#Highlight::not_equal

#Highlight::to_repr

#Index

#Index::build

#Index::container

#Index::depth

#Index::find_member

#Index::node

#Index::owner

#IndexResult

#Key

#Key::equal

#Key::not_equal

#Key::to_repr

#Limits

#Limits::equal

#Limits::new

#Limits::not_equal

#Limits::to_repr

#Member

#Member::equal

#Member::index

#Member::named

#Member::not_equal

#Member::to_repr

#Node

#Node::array

#Node::equal

#Node::is_container

#Node::members

#Node::new

#Node::not_equal

#Node::object

#Node::to_repr

#Value

#Value::equal

#Value::not_equal

#Value::scalar_text

#Value::to_repr

#diagnostic_codes

#valid_number

#validate

Source Files

DataTree

DataTree::equal

DataTree::new

DataTree::not_equal

DataTree::to_repr

Highlight

Highlight::equal

Highlight::new

Highlight::not_equal

Highlight::to_repr

Index

Index::build

Index::container

Index::depth

Index::find_member

Index::node

Index::owner

IndexResult

Key

Key::equal

Key::not_equal

Key::to_repr

Limits

Limits::equal

Limits::new

Limits::not_equal

Limits::to_repr

Member

Member::equal

Member::index

Member::named

Member::not_equal

Member::to_repr

Node

Node::array

Node::equal

Node::is_container

Node::members

Node::new

Node::not_equal

Node::object

Node::to_repr

Value

Value::equal

Value::not_equal

Value::scalar_text

Value::to_repr

diagnostic_codes

valid_number

validate